aclcontroller

Documentation

Overview

The acl controller package provides controller functions for the /acl endpoints in the api V1.

Index

• func CheckAcl() gin.HandlerFunc
• func Create() gin.HandlerFunc
• func Delete() gin.HandlerFunc
• func GetByFilter() gin.HandlerFunc
• func GetById() gin.HandlerFunc
• func GetScopes() gin.HandlerFunc
• func MigrateAcls() gin.HandlerFunc
• func Update() gin.HandlerFunc

Functions

func CheckAcl

func CheckAcl() gin.HandlerFunc

TODO: Describe

@Summary	Check acl
@Schemes
@Description	Check acl by scope, subject and access method
@Tags			acl
@Accept			application/json
@Produce		application/json
@Success		200
@Failure		403
@Failure		401									{object}	rorerror.RorError
@Failure		500									{object}	rorerror.RorError
@Param			scope								path		string	false	"Scope"
@Param			subject								path		string	false	"Subject"
@Param			access								path		string	false	"read,write,update or delete"
@Router			/v1/acl/{scope}/{subject}/{access}	[head]
@Security		ApiKey || AccessToken

func Create

func Create() gin.HandlerFunc

TODO: Describe

@Summary	Create acl
@Schemes
@Description	Create acl
@Tags			acl
@Accept			application/json
@Produce		application/json
@Success		200		{object}	aclmodels.AclV2ListItem
@Failure		403		{object}	rorerror.RorError
@Failure		401		{object}	rorerror.RorError
@Failure		500		{object}	rorerror.RorError
@Router			/v1/acl	[post]
@Param			acl		body	aclmodels.AclV2ListItem	true	"Acl"
@Security		ApiKey || AccessToken

func Delete

func Delete() gin.HandlerFunc

TODO: Describe

@Summary		Delete acl
@Description	Delete a acl by id
@Tags			acl
@Accept			application/json
@Produce		application/json
@Success		200				{bool}		bool
@Failure		403				{object}	rorerror.RorError
@Failure		401				{object}	rorerror.RorError
@Failure		500				{object}	rorerror.RorError
@Router			/v1/acl/{aclId}	[delete]
@Param			aclId			path	string	true	"aclId"
@Security		ApiKey || AccessToken

func GetByFilter

func GetByFilter() gin.HandlerFunc

TODO: Describe

@Summary	Get acl by filter
@Schemes
@Description	Get acl by filter
@Tags			acl
@Accept			application/json
@Produce		application/json
@Success		200				{object}	apicontracts.PaginatedResult[aclmodels.AclV2ListItem]
@Failure		403				{object}	rorerror.RorError
@Failure		401				{object}	rorerror.RorError
@Failure		500				{object}	rorerror.RorError
@Router			/v1/acl/filter	[post]
@Param			filter			body	apicontracts.Filter	true	"Filter"
@Security		ApiKey || AccessToken

func GetById

func GetById() gin.HandlerFunc

TODO: Describe

@Summary	Get acl by id
@Schemes
@Description	Get acl by id
@Tags			acl
@Accept			application/json
@Produce		application/json
@Success		200				{object}	apicontracts.PaginatedResult[aclmodels.AclV2ListItem]
@Failure		403				{object}	rorerror.RorError
@Failure		401				{object}	rorerror.RorError
@Failure		500				{object}	rorerror.RorError
@Router			/v1/acl/{aclId}	[get]
@Param			id				path	string	true	"id"
@Security		ApiKey || AccessToken

func GetScopes

func GetScopes() gin.HandlerFunc

GetScopes provides a array of aclmodels.Acl2Scope

@Summary	Get acl scopes
@Schemes
@Description	Get acl scopes
@Tags			acl
@Accept			application/json
@Produce		application/json
@Success		200				{array}		aclmodels.Acl2Scope
@Failure		403				{object}	rorerror.RorError
@Failure		401				{object}	rorerror.RorError
@Failure		500				{object}	rorerror.RorError
@Router			/v1/acl/scopes	[get]
@Security		ApiKey || AccessToken

func MigrateAcls

func MigrateAcls() gin.HandlerFunc

TODO: Describe

@Summary	Migrate acl
@Schemes
@Description	Migrate acl
@Tags			acl
@Accept			application/json
@Produce		application/json
@Param			id	path		string	true	"id"
@Success		200	{string}	Status
@Failure		403	{string}	Forbidden
@Failure		401	{string}	Unauthorized
@Failure		500	{string}	Failure	message
@Router			/v1/acl/migrate [get]
@Security		ApiKey || AccessToken

func Update

func Update() gin.HandlerFunc

TODO: Describe

@Summary	Update acl
@Schemes
@Description	Update acl
@Tags			acl
@Accept			application/json
@Produce		application/json
@Success		200				{object}	aclmodels.AclV2ListItem
@Failure		403				{object}	rorerror.RorError
@Failure		401				{object}	rorerror.RorError
@Failure		500				{object}	rorerror.RorError
@Router			/v1/acl/{aclId}	[put]
@Param			aclId			path	string					true	"aclId"
@Param			acl				body	aclmodels.AclV2ListItem	true	"Acl"
@Security		ApiKey || AccessToken