api

Documentation

Index

• type Aggregation
• type AggregationAlgorithm
• type AggregationItem
• type Direction
• type GroupingItem
• type Interface
  • func NewInterface(container service.Container) Interface
• type ListParams
• type LoadParams
• type RecordListResult
• type SaveMode
• type SortingItem

Types

type Aggregation

type Aggregation struct {
	Items    []AggregationItem `json:"items,omitempty"`
	Grouping []GroupingItem    `json:"grouping,omitempty"`
}

type AggregationAlgorithm

type AggregationAlgorithm string

const (
	Count AggregationAlgorithm = "COUNT"
	Sum   AggregationAlgorithm = "SUM"
	Avg   AggregationAlgorithm = "AVG"
	Max   AggregationAlgorithm = "MAX"
	Min   AggregationAlgorithm = "MIN"
)

type AggregationItem

type AggregationItem struct {
	Name      string               `json:"name,omitempty"`
	Algorithm AggregationAlgorithm `json:"algorithm,omitempty"`
	Property  string               `json:"property,omitempty"`
}

type Direction

type Direction string

const (
	Asc  Direction = "ASC"
	Desc Direction = "DESC"
)

type GroupingItem

type GroupingItem struct {
	Property string `json:"property,omitempty"`
}

type Interface

type Interface interface {
	Create(ctx context.Context, record unstructured.Unstructured) (unstructured.Unstructured, errors.ServiceError)
	Update(ctx context.Context, record unstructured.Unstructured) (unstructured.Unstructured, errors.ServiceError)
	Apply(ctx context.Context, record unstructured.Unstructured) (unstructured.Unstructured, errors.ServiceError)
	Load(ctx context.Context, record unstructured.Unstructured, params LoadParams) (unstructured.Unstructured, errors.ServiceError)
	Delete(ctx context.Context, record unstructured.Unstructured) errors.ServiceError
	List(ctx context.Context, params ListParams) (RecordListResult, errors.ServiceError)
}

Interface Api interface is a facade for all api services /*

func NewInterface

func NewInterface(container service.Container) Interface

type ListParams

type ListParams struct {
	Query             *resource_model.BooleanExpression `json:"query,omitempty"`
	Type              string                            `type:"and,omitempty"`
	Limit             uint32                            `json:"limit,omitempty"`
	Offset            uint64                            `json:"offset,omitempty"`
	UseHistory        bool                              `json:"useHistory,omitempty"`
	ResolveReferences []string                          `json:"resolveReferences,omitempty"`
	Filters           map[string]string                 `json:"filters,omitempty"`
	Aggregation       *Aggregation                      `json:"aggregation,omitempty"`
	Sorting           []SortingItem                     `json:"sorting,omitempty"`
}

type LoadParams

type LoadParams struct {
	UseHistory        bool     `json:"useHistory,omitempty"`
	ResolveReferences []string `json:"resolveReferences,omitempty"`
}

type RecordListResult

type RecordListResult struct {
	Total   uint32                      `json:"total"`
	Content []unstructured.Unstructured `json:"content"`
}

type SaveMode

type SaveMode int

const (
	Create SaveMode = iota
	Update
	Apply
)

type SortingItem

type SortingItem struct {
	Property  string    `json:"property,omitempty"`
	Direction Direction `json:"direction,omitempty"`
}