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

# README

Go API client for openapi_JOSEProtectedMessageForwarding

N32-f Message Forwarding 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/net/context

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

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

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

Documentation for API Endpoints

All URIs are relative to https://example.com/n32f-forward/v1

ClassMethodHTTP requestDescription
N32FForwardApiN32fProcessOptionsOptions /n32f-processDiscover communication options supported by next hop (IPX or SEPP)
N32FForwardApiPostN32fProcessPost /n32f-processN32-f Message Forwarding

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.
IndexToEncryptedValueAsEncodedHttpHeaderValue is a convenience function that returns IndexToEncryptedValue wrapped in EncodedHttpHeaderValue.
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.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewDataToIntegrityProtectAndCipherBlock instantiates a new DataToIntegrityProtectAndCipherBlock 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.
NewDataToIntegrityProtectAndCipherBlockWithDefaults instantiates a new DataToIntegrityProtectAndCipherBlock 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.
NewDataToIntegrityProtectBlock instantiates a new DataToIntegrityProtectBlock 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.
NewDataToIntegrityProtectBlockWithDefaults instantiates a new DataToIntegrityProtectBlock 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.
NewFlatJweJson instantiates a new FlatJweJson 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.
NewFlatJweJsonWithDefaults instantiates a new FlatJweJson 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.
NewFlatJwsJson instantiates a new FlatJwsJson 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.
NewFlatJwsJsonWithDefaults instantiates a new FlatJwsJson 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.
NewHttpHeader instantiates a new HttpHeader 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.
NewHttpHeaderWithDefaults instantiates a new HttpHeader 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.
NewHttpPayload instantiates a new HttpPayload 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.
NewHttpPayloadWithDefaults instantiates a new HttpPayload 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.
NewIndexToEncryptedValue instantiates a new IndexToEncryptedValue 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.
NewIndexToEncryptedValueWithDefaults instantiates a new IndexToEncryptedValue 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.
NewMetaData instantiates a new MetaData 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.
NewMetaDataWithDefaults instantiates a new MetaData 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.
NewModifications instantiates a new Modifications 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.
NewModificationsWithDefaults instantiates a new Modifications 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.
NewN32fReformattedReqMsg instantiates a new N32fReformattedReqMsg 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.
NewN32fReformattedReqMsgWithDefaults instantiates a new N32fReformattedReqMsg 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.
NewN32fReformattedRspMsg instantiates a new N32fReformattedRspMsg 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.
NewN32fReformattedRspMsgWithDefaults instantiates a new N32fReformattedRspMsg 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
NewPatchItem instantiates a new PatchItem 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.
NewPatchItemWithDefaults instantiates a new PatchItem 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.
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.
NewRequestLine instantiates a new RequestLine 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.
NewRequestLineWithDefaults instantiates a new RequestLine 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.
stringAsEncodedHttpHeaderValue is a convenience function that returns string wrapped in EncodedHttpHeaderValue.

# 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 JOSE Protected Message Forwarding API API v1.3.0-alpha.1 In most cases there should be only one, shared, APIClient.
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
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
DataToIntegrityProtectAndCipherBlock HTTP header to be encrypted or the value of a JSON attribute to be encrypted.
DataToIntegrityProtectBlock Data to be integrity protected.
EncodedHttpHeaderValue - HTTP header value or index to the HTTP header value.
FlatJweJson Contains the integrity protected reformatted block.
FlatJwsJson Contains the modification from IPXes on path.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
HttpHeader Contains the encoding of HTTP headers in the API request / response.
HttpMethod Enumeration of HTTP methods.
HttpPayload Contains the encoding of JSON payload in the API request / response.
IeLocation Location of the IE in a HTTP message.
IndexToEncryptedValue Index to the encrypted value.
InvalidParam It contains an invalid parameter and a related description.
MetaData Contains the meta data information needed for replay protection.
Modifications Information on inserting of the modifications entry.
N32fReformattedReqMsg Contains the reformatted HTTP/2 request message.
N32fReformattedRspMsg Contains the reformatted HTTP/2 response message.
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
PatchItem it contains information on data to be changed.
PatchOperation Operations as defined in IETF RFC 6902.
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.
RequestLine Contains the request line of the HTTP API request being reformatted and forwarded over N32-f.
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.
UriScheme HTTP and HTTPS URI scheme.

# Interfaces

No description provided by the author

# Type aliases

N32FForwardApiService N32FForwardApi service.
ServerConfigurations stores multiple ServerConfiguration items.