Go API client for sourcesapi

Sources

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: 3.1.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 "./sourcesapi"

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 https://cloud.redhat.com//api/sources/v3.1

Class	Method	HTTP request	Description
DefaultApi	BulkCreate	Post /bulk_create	Bulk-create a Source and specified sub-resources
DefaultApi	CheckAvailabilitySource	Post /sources/{id}/check_availability	Checks Availability of a Source
DefaultApi	CreateApplication	Post /applications	Create a new Application
DefaultApi	CreateApplicationAuthentication	Post /application_authentications	Create a new ApplicationAuthentication
DefaultApi	CreateAuthentication	Post /authentications	Create a new Authentication
DefaultApi	CreateEndpoint	Post /endpoints	Create a new Endpoint
DefaultApi	CreateSource	Post /sources	Create a new Source
DefaultApi	DeleteApplication	Delete /applications/{id}	Delete an existing Application
DefaultApi	DeleteApplicationAuthentication	Delete /application_authentications/{id}	Delete an existing ApplicationAuthentication
DefaultApi	DeleteAuthentication	Delete /authentications/{id}	Delete an existing Authentication
DefaultApi	DeleteEndpoint	Delete /endpoints/{id}	Delete an existing Endpoint
DefaultApi	DeleteSource	Delete /sources/{id}	Delete an existing Source
DefaultApi	GetDocumentation	Get /openapi.json	Return this API document in JSON format
DefaultApi	ListAllAppMetaData	Get /app_meta_data	List AppMetaData
DefaultApi	ListAllApplicationAuthentications	Get /application_authentications	List ApplicationAuthentications
DefaultApi	ListApplicationAuthentications	Get /applications/{id}/authentications	List Authentications for Application
DefaultApi	ListApplicationTypeAppMetaData	Get /application_types/{id}/app_meta_data	List AppMetaData for ApplicationType
DefaultApi	ListApplicationTypeSources	Get /application_types/{id}/sources	List Sources for ApplicationType
DefaultApi	ListApplicationTypes	Get /application_types	List ApplicationTypes
DefaultApi	ListApplications	Get /applications	List Applications
DefaultApi	ListAuthentications	Get /authentications	List Authentications
DefaultApi	ListEndpointAuthentications	Get /endpoints/{id}/authentications	List Authentications for Endpoint
DefaultApi	ListEndpoints	Get /endpoints	List Endpoints
DefaultApi	ListSourceApplicationTypes	Get /sources/{id}/application_types	List ApplicationTypes for Source
DefaultApi	ListSourceApplications	Get /sources/{id}/applications	List Applications for Source
DefaultApi	ListSourceAuthentications	Get /sources/{id}/authentications	List Authentications for Source
DefaultApi	ListSourceEndpoints	Get /sources/{id}/endpoints	List Endpoints for Source
DefaultApi	ListSourceTypeSources	Get /source_types/{id}/sources	List Sources for SourceType
DefaultApi	ListSourceTypes	Get /source_types	List SourceTypes
DefaultApi	ListSources	Get /sources	List Sources
DefaultApi	PostGraphQL	Post /graphql	Perform a GraphQL Query
DefaultApi	ShowAppMetaData	Get /app_meta_data/{id}	Show an existing AppMetaData
DefaultApi	ShowApplication	Get /applications/{id}	Show an existing Application
DefaultApi	ShowApplicationAuthentication	Get /application_authentications/{id}	Show an existing ApplicationAuthentication
DefaultApi	ShowApplicationType	Get /application_types/{id}	Show an existing ApplicationType
DefaultApi	ShowAuthentication	Get /authentications/{id}	Show an existing Authentication
DefaultApi	ShowEndpoint	Get /endpoints/{id}	Show an existing Endpoint
DefaultApi	ShowSource	Get /sources/{id}	Show an existing Source
DefaultApi	ShowSourceType	Get /source_types/{id}	Show an existing SourceType
DefaultApi	UpdateApplication	Patch /applications/{id}	Update an existing Application
DefaultApi	UpdateApplicationAuthentication	Patch /application_authentications/{id}	Update an existing ApplicationAuthentication
DefaultApi	UpdateAuthentication	Patch /authentications/{id}	Update an existing Authentication
DefaultApi	UpdateEndpoint	Patch /endpoints/{id}	Update an existing Endpoint
DefaultApi	UpdateSource	Patch /sources/{id}	Update an existing Source

Documentation For Models

• AppMetaData
• AppMetaDataCollection
• Application
• ApplicationAuthentication
• ApplicationAuthenticationsCollection
• ApplicationType
• ApplicationTypesCollection
• ApplicationsCollection
• Authentication
• AuthenticationExtra
• AuthenticationExtraAzure
• AuthenticationsCollection
• BulkCreatePayload
• BulkCreatePayloadApplications
• BulkCreatePayloadAuthentications
• BulkCreatePayloadEndpoints
• BulkCreatePayloadSources
• BulkCreateResponse
• CollectionLinks
• CollectionMetadata
• Endpoint
• EndpointsCollection
• ErrorNotFound
• ErrorNotFoundErrors
• GraphQLRequest
• GraphQLResponse
• Source
• SourceType
• SourceTypesCollection
• SourcesCollection

Documentation For Authorization

UserSecurity

• Type: HTTP basic authentication

Example

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

support@redhat.com