Go API client for ossindex

This documents the available APIs into Sonatype OSS Index - API Version: 1-SNAPSHOT (be72c8343baab38a8c598d28dafc78003dce81db).

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: 2024.323
• Package version: 1.0.0
• Generator version: 7.10.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/sonatype-nexus-community

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 ossindex "github.com/sonatype-nexus-community/ossindex-api-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 ossindex.ContextServerIndex of type int.

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to https://ossindex.sonatype.org

Class	Method	HTTP request	Description
ComponentVulnerabilityReportsAPI	Post	Post /api/v3/component-report	Request vulnerability reports for components
ComponentVulnerabilityReportsAPI	Post1	Post /api/v3/authorized/component-report	Request vulnerability reports for components
VersionAPI	Get	Get /api/v3/version	Get service version information

Documentation For Models

• ComponentReport
• ComponentReportRequest
• ComponentReportVulnerability
• Version

Documentation For Authorization

Authentication schemes defined for the API:

apiToken

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), ossindex.ContextBasicAuth, ossindex.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

basicAuth

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), ossindex.ContextBasicAuth, ossindex.BasicAuth{
	UserName: "username",
	Password: "password",
})
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