api

Documentation

Overview

Package api implements REST API support for Aptomi, including user-level and admin-level calls. It relies on httprouter to process HTTP requests and serve HTTP responses.

Index

• Variables
• func Serve(router *httprouter.Router, store store.Core, externalData *external.Data, ...)
• type AuthRequest
• type AuthSuccess
• type Claims
  • func (claims Claims) Valid() error
• type Endpoints
• type PolicyUpdateResult
  • func (result *PolicyUpdateResult) AsColumns() map[string]string
  • func (result *PolicyUpdateResult) GetDefaultColumns() []string
• type ServerError
  • func NewServerError(error string) *ServerError

Variables

var AuthRequestObject = &runtime.Info{
	Kind:        "auth-request",
	Constructor: func() runtime.Object { return &AuthRequest{} },
}

AuthRequestObject contains Info for the AuthRequest type

var AuthSuccessObject = &runtime.Info{
	Kind:        "auth-success",
	Constructor: func() runtime.Object { return &AuthSuccess{} },
}

AuthSuccessObject contains Info for the AuthSuccess type

var EndpointsObject = &runtime.Info{
	Kind:        "endpoints",
	Constructor: func() runtime.Object { return &Endpoints{} },
}

EndpointsObject is an informational data structure with Kind and Constructor for Endpoints

var (
	// Objects is a list of all objects used in API
	Objects = runtime.AppendAll([]*runtime.Info{
		EndpointsObject,
		PolicyUpdateResultObject,
		AuthSuccessObject,
		AuthRequestObject,
		ServerErrorObject,
		version.BuildInfoObject,
	}, lang.PolicyObjects, engine.Objects)
)

var PolicyUpdateResultObject = &runtime.Info{
	Kind:        "policy-update-result",
	Constructor: func() runtime.Object { return &PolicyUpdateResult{} },
}

PolicyUpdateResultObject is an informational data structure with Kind and Constructor for PolicyUpdateResult

var ServerErrorObject = &runtime.Info{
	Kind:        "error",
	Constructor: func() runtime.Object { return &ServerError{} },
}

ServerErrorObject contains Info for the Error type

Functions

func Serve

func Serve(router *httprouter.Router, store store.Core, externalData *external.Data, pluginRegistryFactory plugin.RegistryFactory, secret string, policyChanged chan bool)

Serve initializes everything needed by REST API and registers all API endpoints in the provided http router

Types

type AuthRequest

type AuthRequest struct {
	runtime.TypeKind `yaml:",inline"`
	Username         string
	Password         string
}

AuthRequest represents authentication request

type AuthSuccess

type AuthSuccess struct {
	runtime.TypeKind `yaml:",inline"`
	Token            string
}

AuthSuccess represents successful authentication

type Claims

type Claims struct {
	Name string `json:"name"`
	jwt.StandardClaims
}

Claims represent Aptomi JWT Claims

func (Claims) Valid

func (claims Claims) Valid() error

Valid checks if claims are valid

type Endpoints

type Endpoints struct {
	runtime.TypeKind `yaml:",inline"`
	List             map[string]map[string]string
}

Endpoints object represents

type PolicyUpdateResult

type PolicyUpdateResult struct {
	runtime.TypeKind `yaml:",inline"`
	PolicyGeneration runtime.Generation
	PolicyChanged    bool
	Actions          []string
}

PolicyUpdateResult represents results for the policy update request (estimated list of actions to be executed to update existing actual state to the desired state)

func (*PolicyUpdateResult) AsColumns

func (result *PolicyUpdateResult) AsColumns() map[string]string

AsColumns returns PolicyUpdateResult representation as columns

func (*PolicyUpdateResult) GetDefaultColumns

func (result *PolicyUpdateResult) GetDefaultColumns() []string

GetDefaultColumns returns default set of columns to be displayed

type ServerError

type ServerError struct {
	runtime.TypeKind `yaml:",inline"`
	Error            string
}

ServerError represents error that could be returned from the API

func NewServerError

func NewServerError(error string) *ServerError

NewServerError returns instance of the error based on the provided error