model

Documentation

Index

• type APIBundle
• type APIDefinition
• type Application
• type Auth
• type Basic
• type CSRFInfo
• type Credentials
• type EventAPIDefinition
• type Labels
• type Oauth
• type RequestParameters
  • func (r RequestParameters) IsEmpty() bool

Types

type APIBundle

type APIBundle struct {
	ID                             string
	Name                           string
	Description                    *string
	InstanceAuthRequestInputSchema *string
	APIDefinitions                 []APIDefinition
	EventDefinitions               []EventAPIDefinition
	DefaultInstanceAuth            *Auth
}

type APIDefinition

type APIDefinition struct {
	ID          string
	Name        string
	Description string
	TargetUrl   string
	Credentials *Credentials
}

APIDefinition contains API data such as URL, and credentials

type Application

type Application struct {
	ID                  string
	Name                string
	ProviderDisplayName string
	Description         string
	Labels              Labels
	SystemAuthsIDs      []string
	ApiBundles          []APIBundle
}

Application contains all associated APIs, and EventAPIs

type Auth

type Auth struct {
	// Credentials
	Credentials *Credentials
	// Additional request parameters
	RequestParameters *RequestParameters
}

Auth contains authentication data

type Basic

type Basic struct {
	// Username to use for authentication.
	Username string
	// Password to use for authentication.
	Password string
}

Basic contains user and password for Basic Auth

type CSRFInfo

type CSRFInfo struct {
	TokenEndpointURL string
}

CSRFInfo contains data for performing CSRF token request

type Credentials

type Credentials struct {
	// OAuth configuration
	Oauth *Oauth
	// BasicAuth configuration
	Basic *Basic
	// Optional CSRF Data
	CSRFInfo *CSRFInfo
}

Credentials contains OAuth or BasicAuth configuration along with optional CSRF data.

type EventAPIDefinition

type EventAPIDefinition struct {
	ID          string
	Name        string
	Description string
}

EventAPIDefinition contains Event API details

type Labels

type Labels map[string]interface{}

type Oauth

type Oauth struct {
	// URL to OAuth token provider.
	URL string
	// ClientID to use for authentication.
	ClientID string
	// ClientSecret to use for authentication.
	ClientSecret string
}

Oauth contains data for performing Oauth token request

type RequestParameters

type RequestParameters struct {
	// Additional headers
	Headers *map[string][]string `json:"headers"`
	// Additional query parameters
	QueryParameters *map[string][]string `json:"queryParameters"`
}

RequestParameters contains additional headers and query parameters

func (RequestParameters) IsEmpty

func (r RequestParameters) IsEmpty() bool

IsEmpty returns true if additional headers and query parameters contain no data, otherwise false