Go API client for okclient

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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: v1
• Package version: 30.5.4
• Generator version: 7.7.0-SNAPSHOT
• 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 okclient "github.com/max-bytes/omnikeeper-client-go"

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

ctx := context.WithValue(context.Background(), okclient.ContextServerIndex, 1)

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AnsibleInventoryScanIngestAPI	AnsibleInventoryScanIngestIngestAnsibleInventoryScan	Post /api/v{version}/Ingest/AnsibleInventoryScan
AuthRedirectAPI	AuthRedirectIndex	Get /.well-known/openid-configuration
CytoscapeAPI	CytoscapeTraitCentric	Get /api/v{version}/Cytoscape/traitCentric
GraphQLAPI	GraphQLDebug	Post /graphql-debug
GraphQLAPI	GraphQLGet	Get /graphql
GraphQLAPI	GraphQLIndex	Post /graphql
GraphvizDotAPI	GraphvizDotLayerCentric	Get /api/v{version}/GraphvizDot/layerCentric
GraphvizDotAPI	GraphvizDotTraitCentric	Get /api/v{version}/GraphvizDot/traitCentric
GridViewAPI	GridViewAddContext	Post /api/v{version}/GridView/context	Adds new context
GridViewAPI	GridViewChangeData	Post /api/v{version}/GridView/contexts/{context}/change	Saves grid view row changes and returns change results
GridViewAPI	GridViewDeleteContext	Delete /api/v{version}/GridView/context/{name}	Deletes specific context
GridViewAPI	GridViewEditContext	Put /api/v{version}/GridView/context/{name}	Edits specific context
GridViewAPI	GridViewGetData	Get /api/v{version}/GridView/contexts/{context}/data	Returns grid view data for specific context
GridViewAPI	GridViewGetGridViewContext	Get /api/v{version}/GridView/context/{name}	Returns a single context in full
GridViewAPI	GridViewGetGridViewContexts	Get /api/v{version}/GridView/contexts	Returns a list of contexts for grid view.
GridViewAPI	GridViewGetSchema	Get /api/v{version}/GridView/contexts/{context}/schema	Returns grid view schema for specific context
ImportExportLayerAPI	ImportExportLayerExportLayer	Get /api/v{version}/ImportExportLayer/exportLayer
MetadataAPI	MetadataGetMetadata	Get /api/odata/{context}/$metadata
MetadataAPI	MetadataGetServiceDocument	Get /api/odata/{context}
OKPluginGenericJSONIngestAPI	ManageContextGetAllContexts	Get /api/v{version}/ingest/genericJSON/manage/context
OKPluginGenericJSONIngestAPI	ManageContextGetContext	Get /api/v{version}/ingest/genericJSON/manage/context/{id}
OKPluginGenericJSONIngestAPI	ManageContextRemoveContext	Delete /api/v{version}/ingest/genericJSON/manage/context/{id}
OKPluginGenericJSONIngestAPI	ManageContextUpsertContext	Post /api/v{version}/ingest/genericJSON/manage/context
OKPluginGenericJSONIngestAPI	PassiveDataIngest	Post /api/v{version}/ingest/genericJSON/data
RestartApplicationAPI	RestartApplicationRestart	Get /api/v{version}/RestartApplication/restart
UsageStatsAPI	UsageStatsFetch	Get /api/v{version}/UsageStats/fetch

Documentation For Models

• AbstractInboundIDMethod
• AddContextRequest
• AnsibleInventoryScanDTO
• AttributeValueDTO
• AttributeValueType
• ChangeDataCell
• ChangeDataRequest
• EditContextRequest
• EdmContainerElementKind
• EdmExpressionKind
• EdmSchemaElementKind
• EdmTypeKind
• GenericInboundAttribute
• GenericInboundCI
• GenericInboundCIIdMethod
• GenericInboundData
• GenericInboundRelation
• GraphQLQuery
• GridViewColumn
• GridViewConfiguration
• IEdmEntityContainer
• IEdmEntityContainerElement
• IEdmExpression
• IEdmModel
• IEdmSchemaElement
• IEdmTerm
• IEdmType
• IEdmTypeReference
• IEdmVocabularyAnnotation
• InboundIDMethodByAttribute
• InboundIDMethodByAttributeModifiers
• InboundIDMethodByByUnion
• InboundIDMethodByData
• InboundIDMethodByIntersect
• InboundIDMethodByRelatedTempID
• InboundIDMethodByTemporaryCIID
• NoFoundTargetCIHandling
• ODataEntitySetInfo
• ODataFunctionImportInfo
• ODataServiceDocument
• ODataSingletonInfo
• ODataTypeAnnotation
• ProblemDetails
• SameTargetCIHandling
• SameTempIDHandling
• SparseRow

Documentation For Authorization

Authentication schemes defined for the API:

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Example

auth := context.WithValue(context.Background(), okclient.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, okclient.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://[keycloak-url]/auth/realms/acme/protocol/openid-connect/auth
• Scopes: N/A

Example

auth := context.WithValue(context.Background(), okclient.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, okclient.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

Author