restapi

package
v0.0.0-...-33e56a9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 24, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package restapi Event Engine Management API

An API which supports creation, deletion, listing etc of Event Engine
Schemes:
  http
  https
Host: localhost:8000
BasePath: /api/v1.0
Version: 1.0.0
License: Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.html
Contact: <diego@cyclops-labs.io>

Consumes:
  - application/json

Produces:
  - application/json

swagger:meta

Index

Constants

View Source
const AuthKey contextKey = "Auth"

Variables

View Source
var (
	// SwaggerJSON embedded version of the swagger document used at generation time
	SwaggerJSON json.RawMessage
	// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
	FlatSwaggerJSON json.RawMessage
)

Functions

func Handler

func Handler(c Config) (http.Handler, error)

Handler returns an http.Handler given the handler configuration It mounts all the business logic implementers in the right routing.

func HandlerAPI

HandlerAPI returns an http.Handler given the handler configuration and the corresponding *EventEngineManagementAPI instance. It mounts all the business logic implementers in the right routing.

Types

type Config

type Config struct {
	EventManagementAPI
	StatusManagementAPI
	TriggerManagementAPI
	UsageManagementAPI
	Logger func(string, ...interface{})
	// InnerMiddleware is for the handler executors. These do not apply to the swagger.json document.
	// The middleware executes after routing but before authentication, binding and validation
	InnerMiddleware func(http.Handler) http.Handler

	// Authorizer is used to authorize a request after the Auth function was called using the "Auth*" functions
	// and the principal was stored in the context in the "AuthKey" context value.
	Authorizer func(*http.Request) error

	// AuthAPIKeyHeader Applies when the "X-API-KEY" header is set
	AuthAPIKeyHeader func(token string) (interface{}, error)

	// AuthAPIKeyParam Applies when the "api_key" query is set
	AuthAPIKeyParam func(token string) (interface{}, error)

	// AuthKeycloak For OAuth2 authentication
	AuthKeycloak func(token string, scopes []string) (interface{}, error)
	// Authenticator to use for all APIKey authentication
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
	// Authenticator to use for all Bearer authentication
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
	// Authenticator to use for all Basic authentication
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator
}

Config is configuration for Handler

type EventManagementAPI

type EventManagementAPI interface {
	/* AddEvent Takes into the system the provided event */
	AddEvent(ctx context.Context, params event_management.AddEventParams) middleware.Responder

	/* GetHistory Provides the events for the id provided */
	GetHistory(ctx context.Context, params event_management.GetHistoryParams) middleware.Responder

	/* GetState Provides the events for the id provided */
	GetState(ctx context.Context, params event_management.GetStateParams) middleware.Responder

	/* ListStates Provides the list of states in not terminated state */
	ListStates(ctx context.Context, params event_management.ListStatesParams) middleware.Responder
}

EventManagementAPI

type StatusManagementAPI

type StatusManagementAPI interface {
	/* GetStatus Basic status of the system */
	GetStatus(ctx context.Context, params status_management.GetStatusParams) middleware.Responder

	/* ShowStatus Basic status of the system */
	ShowStatus(ctx context.Context, params status_management.ShowStatusParams) middleware.Responder
}

StatusManagementAPI

type TriggerManagementAPI

type TriggerManagementAPI interface {
	/* ExecSample Sample task trigger */
	ExecSample(ctx context.Context, params trigger_management.ExecSampleParams) middleware.Responder
}

TriggerManagementAPI

type UsageManagementAPI

type UsageManagementAPI interface {
	/* GetSystemUsage Generates an aggregated response by account of the usage recorded in the system during the time-window specified */
	GetSystemUsage(ctx context.Context, params usage_management.GetSystemUsageParams) middleware.Responder

	/* GetUsage Generates an aggregated response of the usage recorded in the system during the time-window specified for the selected account */
	GetUsage(ctx context.Context, params usage_management.GetUsageParams) middleware.Responder
}

UsageManagementAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL