OpenAPI_ProvMnS

package
v0.0.0-...-e403a3c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 22, 2023 License: MIT Imports: 20 Imported by: 0

README

Go API client for OpenAPI_ProvMnS

OAS 3.0.1 definition of the Provisioning MnS © 2023, 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: 17.6.0
  • 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_ProvMnS "gitee.com/konglinglong/openapi/OpenAPI_ProvMnS"

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 OpenAPI_ProvMnS.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), OpenAPI_ProvMnS.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value OpenAPI_ProvMnS.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), OpenAPI_ProvMnS.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 OpenAPI_ProvMnS.ContextOperationServerIndices and OpenAPI_ProvMnS.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), OpenAPI_ProvMnS.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), OpenAPI_ProvMnS.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://example.com/3GPPManagement/ProvMnS/XXX

Class Method HTTP request Description
DefaultAPI ClassNameidDelete Delete /{className}={id} Deletes one resource
DefaultAPI ClassNameidGet Get /{className}={id} Reads one or multiple resources
DefaultAPI ClassNameidPatch Patch /{className}={id} Patches one or multiple resources
DefaultAPI ClassNameidPut Put /{className}={id} Replaces a complete single resource or creates it if it does not exist

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

Documentation

Documentation is too large to display.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.