discovery

Documentation

Index

• Constants
• func BuildServiceBody(service *ServiceDetail) (apic.ServiceBody, error)
• type Agent
  • func NewAgent(cfg config.AgentConfig) *Agent
  • func (a *Agent) Run() error
  • func (a *Agent) Stop()
• type ServiceDetail

Constants

const (
	// MAJOR -
	MAJOR = "MAJOR"
	// MINOR -
	MINOR = "MINOR"
)

Functions

func BuildServiceBody

func BuildServiceBody(service *ServiceDetail) (apic.ServiceBody, error)

BuildServiceBody - creates the service definition

Types

type Agent

type Agent struct {
	Cfg config.AgentConfig
	// contains filtered or unexported fields
}

Agent struct for running the agent

func NewAgent

func NewAgent(cfg config.AgentConfig) *Agent

NewAgent creates an agent for API Discovery

func (*Agent) Run

func (a *Agent) Run() error

Run starts the agent

func (*Agent) Stop

func (a *Agent) Stop()

Stop stops the agent

type ServiceDetail

type ServiceDetail struct {
	AgentDetails      map[string]string
	APIName           string
	APISpec           []byte
	APIUpdateSeverity string
	AuthPolicy        string
	Description       string
	Documentation     []byte
	Endpoint          string
	Endpoints         []apic.EndpointDefinition
	ID                string
	ResourceType      string
	ServiceAttributes map[string]string
	Title             string
}

ServiceDetail - Sample struct representing the API definition in API gateway