# README

Go API client for inventory

REST interface for the Insights Platform Host Inventory application.

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.0.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/oauth2
go get golang.org/x/net/context

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

import sw "./inventory"

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

Documentation for API Endpoints

All URIs are relative to http://localhost/api/inventory/v1

Class	Method	HTTP request	Description
DefaultApi	ApiSystemProfileValidateSchema	Post /system_profile/validate_schema	validate system profile schema
HostsApi	ApiHostDeleteById	Delete /hosts/{host_id_list}	Delete hosts by IDs
HostsApi	ApiHostGetHostById	Get /hosts/{host_id_list}	Find hosts by their IDs
HostsApi	ApiHostGetHostList	Get /hosts	Read the entire list of hosts
HostsApi	ApiHostGetHostSystemProfileById	Get /hosts/{host_id_list}/system_profile	Return one or more hosts system profile
HostsApi	ApiHostGetHostTagCount	Get /hosts/{host_id_list}/tags/count	Get the number of tags on a host
HostsApi	ApiHostGetHostTags	Get /hosts/{host_id_list}/tags	Get the tags on a host
HostsApi	ApiHostHostCheckin	Post /hosts/checkin	Update staleness timestamps for a host matching the provided facts
HostsApi	ApiHostMergeFacts	Patch /hosts/{host_id_list}/facts/{namespace}	Merge facts under a namespace
HostsApi	ApiHostPatchById	Patch /hosts/{host_id_list}	Update a host
HostsApi	ApiHostReplaceFacts	Put /hosts/{host_id_list}/facts/{namespace}	Replace facts under a namespace
SapSystemApi	ApiSystemProfileGetSapSids	Get /system_profile/sap_sids	get sap system values
SapSystemApi	ApiSystemProfileGetSapSystem	Get /system_profile/sap_system	get sap system values
TagsApi	ApiTagGetTags	Get /tags	Get the active host tags for a given account

Documentation For Models

Documentation For Authorization

ApiKeyAuth

Type: API key
API key parameter name: x-rh-identity
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: x-rh-identity and passed in as the auth context for each request.

BearerAuth

Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARERTOKENSTRING")
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