restapi

Documentation

Overview

Package restapi CDR Management API

An API which supports creation, deletion, listing etc of CDR
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
• Variables
• func Handler(c Config) (http.Handler, error)
• func HandlerAPI(c Config) (http.Handler, *operations.CDRManagementAPIAPI, error)
• type Config
• type StatusManagementAPI
• type TriggerManagementAPI
• type UsageManagementAPI

Constants

const AuthKey contextKey = "Auth"

Variables

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

func HandlerAPI(c Config) (http.Handler, *operations.CDRManagementAPIAPI, error)

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

Types

type Config

type Config struct {
	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 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 {
	/* ExecTransformation Transformation of UDR to CDR task trigger */
	ExecTransformation(ctx context.Context, params trigger_management.ExecTransformationParams) middleware.Responder
}

TriggerManagementAPI

type UsageManagementAPI

type UsageManagementAPI interface {
	/* GetSystemUsage Detailed report covering all accounts within the specified time window */
	GetSystemUsage(ctx context.Context, params usage_management.GetSystemUsageParams) middleware.Responder

	/* GetUsage Detailed report covering of the account associated with the id within the specified time window */
	GetUsage(ctx context.Context, params usage_management.GetUsageParams) middleware.Responder

	/* GetUsageSummary Summary report meant for the UI for the resources linked to the ResellerID provided within the specified time window */
	GetUsageSummary(ctx context.Context, params usage_management.GetUsageSummaryParams) middleware.Responder
}

UsageManagementAPI