apikeys

Documentation

Index

• func CreateApikey() gin.HandlerFunc
• func CreateForAgent() gin.HandlerFunc
• func Delete() gin.HandlerFunc
• func GetByFilter() gin.HandlerFunc

Functions

func CreateApikey

func CreateApikey() gin.HandlerFunc

@Summary Create api key @Schemes @Description Create a api key @Tags apikeys @Accept application/json @Produce application/json @Success 200 {string} api key @Failure 403 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {object} rorerror.RorError @Router /v1/apikeys/apikeys [post] @Param project body apicontracts.ApiKey true "Api key" @Security ApiKey || AccessToken

func CreateForAgent

func CreateForAgent() gin.HandlerFunc

TODO: Describe

func Delete

func Delete() gin.HandlerFunc

TODO: Describe

@Summary	Delete api key
@Schemes
@Description	Delete a api key by id
@Tags			api keys
@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/apikeys/{apikeyId}	[delete]
@Param			apikeyId				path	string	true	"apikeyId"
@Security		ApiKey || AccessToken

func GetByFilter

func GetByFilter() gin.HandlerFunc

TODO: Describe

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