model

Documentation

Index

• type API
• type Basic
• type CSRFInfo
• type CertificateGen
• type Credentials
• type Events
• type Oauth
• type RequestParameters
• type ServiceDefinition

Types

type API

type API struct {
	// TargetUrl points to API.
	TargetUrl string
	// Credentials is a credentials of API.
	Credentials *Credentials
	// 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
	// Request Parameters
	RequestParameters *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
	// Optional CSRF Data
	CSRFInfo *CSRFInfo
}

Basic contains details of Basic configuration.

type CSRFInfo

type CSRFInfo struct {
	TokenEndpointURL string
}

type CertificateGen

type CertificateGen struct {
	CommonName  string
	Certificate string
	// Optional CSRF Data
	CSRFInfo *CSRFInfo
}

CertificateGen contains common name of the certificate to generate

type Credentials

type Credentials struct {
	// Oauth is OAuth configuration.
	Oauth          *Oauth
	Basic          *Basic
	CertificateGen *CertificateGen
}

Credentials contains OAuth configuration.

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
	// Optional CSRF Data
	CSRFInfo *CSRFInfo
}

Oauth contains details of OAuth configuration.

type RequestParameters

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

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.