serviceapi

Documentation

Index

• type API
• type Credentials
• type Oauth
• type Service
  • func NewService(secretsRepository secrets.Repository) Service

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
}

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

type Credentials

type Credentials struct {
	// Oauth is OAuth configuration.
	Oauth Oauth
}

Credentials contains OAuth configuration.

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 details of OAuth configuration

type Service

type Service interface {
	// Read reads API from Remote Environment API definition. It also reads all additional information.
	Read(*remoteenv.ServiceAPI) (*API, apperrors.AppError)
}

Service manages API definition of a service

func NewService

func NewService(secretsRepository secrets.Repository) Service