rulesetscontroller

Documentation

Index

• func AddResource() gin.HandlerFunc
• func AddResourceRule() gin.HandlerFunc
• func DeleteResource() gin.HandlerFunc
• func DeleteResourceRule() gin.HandlerFunc
• func GetAll() gin.HandlerFunc
• func GetByCluster() gin.HandlerFunc
• func GetInternal() gin.HandlerFunc

Functions

func AddResource

func AddResource() gin.HandlerFunc

TODO: Describe function

@Summary	Add a resource onto the ruleset
@Schemes
@Description	Append a resource onto the ruleset
@Tags			rulesetsController
@Accept			application/json
@Produce		application/json
@Param			rulesetId	path		string	true	"rulesetId"
@Success		200			{object}	messages.RulesetResourceModel
@Failure		403			{string}	Forbidden
@Failure		401			{string}	Unauthorized
@Failure		500			{string}	Failure	message
@Router			/v1/rulesets/{rulesetId}/resources [post]
@Security		ApiKeyAuth
@Security		OAuth2Application[write, admin]

func AddResourceRule

func AddResourceRule() gin.HandlerFunc

TODO: Describe function

@Summary	Add a resource rule
@Schemes
@Description	Add a resource rule
@Tags			rulesetsController
@Accept			application/json
@Produce		application/json
@Param			rulesetId	path		string	true	"rulesetId"
@Param			resourceId	path		string	true	"resourceId"
@Success		200			{object}	messages.RulesetRuleModel
@Failure		403			{string}	Forbidden
@Failure		401			{string}	Unauthorized
@Failure		500			{string}	Failure	message
@Router			/v1/rulesets/{rulesetId}/resources/{resourceId}/rules [post]
@Security		ApiKeyAuth
@Security		OAuth2Application[write, admin]

func DeleteResource

func DeleteResource() gin.HandlerFunc

TODO: Describe function

@Summary	Delete a resource
@Schemes
@Description	Delete a resource and all of its events.
@Tags			rulesetsController
@Accept			application/json
@Produce		application/json
@Param			rulesetId	path		string	true	"rulesetId"
@Param			resourceId	path		string	true	"resourceId"
@Success		200			{bool}		Deleted
@Failure		403			{string}	Forbidden
@Failure		401			{string}	Unauthorized
@Failure		500			{string}	Failure	message
@Router			/v1/rulesets/{rulesetId}/resources/{resourceId} [delete]
@Security		ApiKeyAuth
@Security		OAuth2Application[write, admin]

func DeleteResourceRule

func DeleteResourceRule() gin.HandlerFunc

TODO: Describe function

@Summary	Add a resource rule
@Schemes
@Description	Add a resource rule
@Tags			rulesetsController
@Accept			application/json
@Produce		application/json
@Param			rulesetId	path		string	true	"rulesetId"
@Param			resourceId	path		string	true	"resourceId"
@Param			ruleId		path		string	true	"ruleId"
@Success		200			{bool}		Deleted
@Failure		403			{string}	Forbidden
@Failure		401			{string}	Unauthorized
@Failure		500			{string}	Failure	message
@Router			/v1/rulesets/{rulesetId}/resources/{resourceId}/rules/{ruleId} [post]
@Security		ApiKeyAuth
@Security		OAuth2Application[write, admin]

func GetAll

func GetAll() gin.HandlerFunc

only in development

func GetByCluster

func GetByCluster() gin.HandlerFunc

TODO: Describe function

@Summary	Get ruleset by cluster
@Schemes
@Description	Get ruleset by cluster
@Tags			rulesetsController
@Accept			application/json
@Produce		application/json
@Param			clusterId	path		string	true	"clusterId"
@Success		200			{object}	messages.RulesetModel
@Failure		403			{string}	Forbidden
@Failure		401			{string}	Unauthorized
@Failure		500			{string}	Failure	message
@Router			/v1/rulesets/cluster/{clusterId} [get]
@Security		ApiKeyAuth
@Security		OAuth2Application[write, admin]

func GetInternal

func GetInternal() gin.HandlerFunc

TODO: Describe function

@Summary	Get internal ruleset
@Schemes
@Description	Get the internal ruleset
@Tags			rulesetsController
@Accept			application/json
@Produce		application/json
@Success		200	{object}	messages.RulesetModel
@Failure		403	{string}	Forbidden
@Failure		401	{string}	Unauthorized
@Failure		500	{string}	Failure	message
@Router			/v1/rulesets/internal [get]
@Security		ApiKeyAuth
@Security		OAuth2Application[write, admin]