model

Documentation

Index

• func RequestParametersToMap(requestParameters *RequestParameters) (map[string][]byte, apperrors.AppError)
• type API
• type Basic
• type CSRFInfo
• type CertificateGen
• type Credentials
• type CredentialsWithCSRF
• type Events
• type Oauth
• type RequestParameters
  • func MapToRequestParameters(data map[string][]byte) (*RequestParameters, apperrors.AppError)
• type ServiceDefinition

Functions

func RequestParametersToMap

func RequestParametersToMap(requestParameters *RequestParameters) (map[string][]byte, apperrors.AppError)

Types

type API

type API struct {
	// TargetUrl points to API.
	TargetUrl string
	// Credentials contains credentials of API.
	Credentials *CredentialsWithCSRF
	// Spec contains specification of an API.
	Spec []byte
	// SpecificationUrl is url from where the specification of an API can be acquired - used if Spec is not defined
	SpecificationUrl string
	// ApiType is a type of and API ex. OData, OpenApi
	ApiType string
	// Additional request parameters
	RequestParameters *RequestParameters
	// Specification Credentials contains credentials for fetching API spec.
	SpecificationCredentials *Credentials
	// Additional request parameters to be used when fetching specification
	SpecificationRequestParameters *RequestParameters
}

API is an internal representation of a service's API.

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 CertificateGen

type CertificateGen struct {
	CommonName  string
	Certificate string
}

CertificateGen contains common name of the certificate to generate

type Credentials

type Credentials struct {
	// OAuth configuration
	Oauth *Oauth
	// BasicAuth configuration
	Basic *Basic
}

Credentials contains OAuth or Basic Auth configuration.

type CredentialsWithCSRF

type CredentialsWithCSRF struct {
	// OAuth configuration
	Oauth *Oauth
	// BasicAuth configuration
	Basic *Basic
	// Certificates configuration
	CertificateGen *CertificateGen
	// Optional CSRF Data
	CSRFInfo *CSRFInfo
}

CredentialsWithCSRF contains OAuth, BasicAuth or Certificates configuration along with optional CSRF data.

type Events

type Events struct {
	// Spec contains data of events specification.
	Spec []byte
}

Events contains specification for events.

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
	// Additional request parameters
	RequestParameters *RequestParameters
}

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 MapToRequestParameters

func MapToRequestParameters(data map[string][]byte) (*RequestParameters, apperrors.AppError)

type ServiceDefinition

type ServiceDefinition struct {
	// ID of service
	ID string
	// Name of a service
	Name string
	// External identifier of a service
	Identifier string
	// Provider of a service
	Provider string
	// Description of a service
	Description string
	// Short description of a service
	ShortDescription string
	// Labels of a service
	Labels *map[string]string
	// Api of a service
	Api *API
	// Events of a service
	Events *Events
	// Documentation of service
	Documentation []byte
}

ServiceDefinition is an internal representation of a service.