Categorygithub.com/5GCoreNet/openapiopenapi_CAPIF_Publish_Service_API
package
1.18.2
Repository: https://github.com/5gcorenet/openapi.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
20
Dependents
0
Files
8.5k SLOC

# README

Go API client for openapi_CAPIF_Publish_Service_API

API for publishing service APIs.
© 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_CAPIF_Publish_Service_API "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_CAPIF_Publish_Service_API"

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

Documentation for API Endpoints

All URIs are relative to https://example.com/published-apis/v1

ClassMethodHTTP requestDescription
DefaultApiApfIdServiceApisGetGet /{apfId}/service-apis
DefaultApiApfIdServiceApisPostPost /{apfId}/service-apis
DefaultApiApfIdServiceApisServiceApiIdDeleteDelete /{apfId}/service-apis/{serviceApiId}
DefaultApiApfIdServiceApisServiceApiIdGetGet /{apfId}/service-apis/{serviceApiId}
DefaultApiApfIdServiceApisServiceApiIdPutPut /{apfId}/service-apis/{serviceApiId}
IndividualAPFPublishedAPIApiModifyIndAPFPubAPIPatch /{apfId}/service-apis/{serviceApiId}

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.
interface{}AsAefProfile is a convenience function that returns interface{} wrapped in AefProfile.
interface{}AsInterfaceDescription is a convenience function that returns interface{} wrapped in InterfaceDescription.
IsNil checks if an input is nil.
NewAefLocation instantiates a new AefLocation 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.
NewAefLocationWithDefaults instantiates a new AefLocation 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.
NewCivicAddress instantiates a new CivicAddress 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.
NewCivicAddressWithDefaults instantiates a new CivicAddress 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.
NewCustomOperation instantiates a new CustomOperation 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.
NewCustomOperationWithDefaults instantiates a new CustomOperation 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.
NewEllipsoidArc instantiates a new EllipsoidArc 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.
NewEllipsoidArcAllOf instantiates a new EllipsoidArcAllOf 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.
NewEllipsoidArcAllOfWithDefaults instantiates a new EllipsoidArcAllOf 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.
NewEllipsoidArcWithDefaults instantiates a new EllipsoidArc 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.
NewGADShape instantiates a new GADShape 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.
NewGADShapeWithDefaults instantiates a new GADShape 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.
NewGeographicalCoordinates instantiates a new GeographicalCoordinates 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.
NewGeographicalCoordinatesWithDefaults instantiates a new GeographicalCoordinates 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.
NewLocal2dPointUncertaintyEllipse instantiates a new Local2dPointUncertaintyEllipse 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.
NewLocal2dPointUncertaintyEllipseAllOf instantiates a new Local2dPointUncertaintyEllipseAllOf 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.
NewLocal2dPointUncertaintyEllipseAllOfWithDefaults instantiates a new Local2dPointUncertaintyEllipseAllOf 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.
NewLocal2dPointUncertaintyEllipseWithDefaults instantiates a new Local2dPointUncertaintyEllipse 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.
NewLocal3dPointUncertaintyEllipsoid instantiates a new Local3dPointUncertaintyEllipsoid 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.
NewLocal3dPointUncertaintyEllipsoidAllOf instantiates a new Local3dPointUncertaintyEllipsoidAllOf 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.
NewLocal3dPointUncertaintyEllipsoidAllOfWithDefaults instantiates a new Local3dPointUncertaintyEllipsoidAllOf 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.
NewLocal3dPointUncertaintyEllipsoidWithDefaults instantiates a new Local3dPointUncertaintyEllipsoid 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.
NewLocalOrigin instantiates a new LocalOrigin 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.
NewLocalOriginWithDefaults instantiates a new LocalOrigin 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
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
NewPoint instantiates a new Point 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.
NewPointAllOf instantiates a new PointAllOf 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.
NewPointAllOfWithDefaults instantiates a new PointAllOf 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.
NewPointAltitude instantiates a new PointAltitude 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.
NewPointAltitudeAllOf instantiates a new PointAltitudeAllOf 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.
NewPointAltitudeAllOfWithDefaults instantiates a new PointAltitudeAllOf 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.
NewPointAltitudeUncertainty instantiates a new PointAltitudeUncertainty 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.
NewPointAltitudeUncertaintyAllOf instantiates a new PointAltitudeUncertaintyAllOf 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.
NewPointAltitudeUncertaintyAllOfWithDefaults instantiates a new PointAltitudeUncertaintyAllOf 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.
NewPointAltitudeUncertaintyWithDefaults instantiates a new PointAltitudeUncertainty 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.
NewPointAltitudeWithDefaults instantiates a new PointAltitude 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.
NewPointUncertaintyCircle instantiates a new PointUncertaintyCircle 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.
NewPointUncertaintyCircleAllOf instantiates a new PointUncertaintyCircleAllOf 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.
NewPointUncertaintyCircleAllOfWithDefaults instantiates a new PointUncertaintyCircleAllOf 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.
NewPointUncertaintyCircleWithDefaults instantiates a new PointUncertaintyCircle 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.
NewPointUncertaintyEllipse instantiates a new PointUncertaintyEllipse 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.
NewPointUncertaintyEllipseAllOf instantiates a new PointUncertaintyEllipseAllOf 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.
NewPointUncertaintyEllipseAllOfWithDefaults instantiates a new PointUncertaintyEllipseAllOf 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.
NewPointUncertaintyEllipseWithDefaults instantiates a new PointUncertaintyEllipse 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.
NewPointWithDefaults instantiates a new Point 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.
NewPolygon instantiates a new Polygon 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.
NewPolygonAllOf instantiates a new PolygonAllOf 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.
NewPolygonAllOfWithDefaults instantiates a new PolygonAllOf 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.
NewPolygonWithDefaults instantiates a new Polygon 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.
NewPublishedApiPath instantiates a new PublishedApiPath 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.
NewPublishedApiPathWithDefaults instantiates a new PublishedApiPath 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.
NewRelativeCartesianLocation instantiates a new RelativeCartesianLocation 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.
NewRelativeCartesianLocationWithDefaults instantiates a new RelativeCartesianLocation 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.
NewResource instantiates a new Resource 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.
NewResourceWithDefaults instantiates a new Resource 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.
NewServiceAPIDescription instantiates a new ServiceAPIDescription 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.
NewServiceAPIDescriptionPatch instantiates a new ServiceAPIDescriptionPatch 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.
NewServiceAPIDescriptionPatchWithDefaults instantiates a new ServiceAPIDescriptionPatch 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.
NewServiceAPIDescriptionWithDefaults instantiates a new ServiceAPIDescription 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.
NewShareableInformation instantiates a new ShareableInformation 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.
NewShareableInformationWithDefaults instantiates a new ShareableInformation 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.
NewUncertaintyEllipse instantiates a new UncertaintyEllipse 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.
NewUncertaintyEllipseWithDefaults instantiates a new UncertaintyEllipse 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.
NewUncertaintyEllipsoid instantiates a new UncertaintyEllipsoid 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.
NewUncertaintyEllipsoidWithDefaults instantiates a new UncertaintyEllipsoid 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.
NewVersion instantiates a new Version 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.
NewVersionWithDefaults instantiates a new Version 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.

# 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

AefLocation Represents the location information (e.g.
AefProfile - Represents the AEF profile data.
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
APIClient manages communication with the CAPIF_Publish_Service_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
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CivicAddress Indicates a Civic address.
CommunicationType Possible values are: - REQUEST_RESPONSE: The communication is of the type request-response - SUBSCRIBE_NOTIFY: The communication is of the type subscribe-notify.
Configuration stores the configuration of the API client.
CustomOperation Represents the description of a custom operation.
DataFormat Possible values are: - JSON: JavaScript Object Notation.
EllipsoidArc Ellipsoid Arc.
EllipsoidArcAllOf struct for EllipsoidArcAllOf.
GADShape Common base type for GAD shapes.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GeographicalCoordinates Geographical coordinates.
GeographicArea Geographic area specified by different shape.
InterfaceDescription - Represents the description of an API's interface.
InvalidParam Represents the description of invalid parameters, for a request rejected due to invalid parameters.
Local2dPointUncertaintyEllipse Local 2D point with uncertainty ellipse.
Local2dPointUncertaintyEllipseAllOf struct for Local2dPointUncertaintyEllipseAllOf.
Local3dPointUncertaintyEllipsoid Local 3D point with uncertainty ellipsoid.
Local3dPointUncertaintyEllipsoidAllOf struct for Local3dPointUncertaintyEllipsoidAllOf.
LocalOrigin Indicates a Local origin in a reference system.
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
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
Operation Possible values are: - GET: HTTP GET method - POST: HTTP POST method - PUT: HTTP PUT method - PATCH: HTTP PATCH method - DELETE: HTTP DELETE method.
Point Ellipsoid Point.
PointAllOf struct for PointAllOf.
PointAltitude Ellipsoid point with altitude.
PointAltitudeAllOf struct for PointAltitudeAllOf.
PointAltitudeUncertainty Ellipsoid point with altitude and uncertainty ellipsoid.
PointAltitudeUncertaintyAllOf struct for PointAltitudeUncertaintyAllOf.
PointUncertaintyCircle Ellipsoid point with uncertainty circle.
PointUncertaintyCircleAllOf struct for PointUncertaintyCircleAllOf.
PointUncertaintyEllipse Ellipsoid point with uncertainty ellipse.
PointUncertaintyEllipseAllOf struct for PointUncertaintyEllipseAllOf.
Polygon Polygon.
PolygonAllOf struct for PolygonAllOf.
ProblemDetails Represents additional information and details on an error response.
Protocol Possible values are: - HTTP_1_1: HTTP version 1.1 - HTTP_2: HTTP version 2.
PublishedApiPath Represents the published API path within the same CAPIF provider domain.
RelativeCartesianLocation Relative Cartesian Location.
Resource Represents the API resource data.
SecurityMethod Possible values are: - PSK: Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122 - PKI: Security method 2 (Using PKI) as described in 3GPP TS 33.122 - OAUTH: Security method 3 (TLS with OAuth token) as described in 3GPP TS 33.122.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
ServiceAPIDescription Represents the description of a service API as published by the APF.
ServiceAPIDescriptionPatch Represents the parameters to request the modification of an APF published API resource.
ShareableInformation Indicates whether the service API and/or the service API category can be shared to the list of CAPIF provider domains.
SupportedGADShapes Indicates supported GAD shapes.
UncertaintyEllipse Ellipse with uncertainty.
UncertaintyEllipsoid Ellipsoid with uncertainty.
Version Represents the API version information.

# Interfaces

No description provided by the author

# Type aliases

DefaultApiService DefaultApi service.
IndividualAPFPublishedAPIApiService IndividualAPFPublishedAPIApi service.
ServerConfigurations stores multiple ServerConfiguration items.