Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 rulesets
@Accept application/json
@Produce application/json
@Param rulesetId path string true "rulesetId"
@Success 200 {object} messages.RulesetResourceModel
@Failure 403 {string} Forbidden
@Failure 400 {object} rorerror.ErrorData
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/rulesets/{rulesetId}/resources [post]
@Security ApiKey || AccessToken
func AddResourceRule ¶
func AddResourceRule() gin.HandlerFunc
TODO: Describe function
@Summary Add a resource rule
@Schemes
@Description Add a resource rule
@Tags rulesets
@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 400 {object} rorerror.ErrorData
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/rulesets/{rulesetId}/resources/{resourceId}/rules [post]
@Security ApiKey || AccessToken
func DeleteResource ¶
func DeleteResource() gin.HandlerFunc
TODO: Describe function
@Summary Delete a resource
@Schemes
@Description Delete a resource and all of its events.
@Tags rulesets
@Accept application/json
@Produce application/json
@Param rulesetId path string true "rulesetId"
@Param resourceId path string true "resourceId"
@Success 200 {boolean} true
@Failure 403 {string} Forbidden
@Failure 400 {object} rorerror.ErrorData
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/rulesets/{rulesetId}/resources/{resourceId} [delete]
@Security ApiKey || AccessToken
func DeleteResourceRule ¶
func DeleteResourceRule() gin.HandlerFunc
TODO: Describe function
@Summary Delete a resource rule
@Schemes
@Description Delete a resource rule
@Tags rulesets
@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 {boolean} true
@Failure 403 {string} Forbidden
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/rulesets/{rulesetId}/resources/{resourceId}/rules/{ruleId} [delete]
@Security ApiKey || AccessToken
func GetByCluster ¶
func GetByCluster() gin.HandlerFunc
TODO: Describe function
@Summary Get ruleset by cluster
@Schemes
@Description Get ruleset by cluster
@Tags rulesets
@Accept application/json
@Produce application/json
@Param clusterId path string true "clusterId"
@Success 200 {object} messages.RulesetModel
@Failure 403 {string} Forbidden
@Failure 400 {object} rorerror.ErrorData
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/rulesets/cluster/{clusterId} [get]
@Security ApiKey || AccessToken
func GetInternal ¶
func GetInternal() gin.HandlerFunc
TODO: Describe function
@Summary Get internal ruleset
@Schemes
@Description Get the internal ruleset
@Tags rulesets
@Accept application/json
@Produce application/json
@Success 200 {object} messages.RulesetModel
@Failure 403 {string} Forbidden
@Failure 401 {object} rorerror.ErrorData
@Failure 500 {string} Failure message
@Router /v1/rulesets/internal [get]
@Security ApiKey || AccessToken
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.