apikeys

Documentation

Index

• func DeleteApiKey(c *gin.Context)
• func GetApiKeys(c *gin.Context)
• func PostApiKey(c *gin.Context)
• func PutApiKey(c *gin.Context)
• type PaginatedApiKeys

Functions

func DeleteApiKey

func DeleteApiKey(c *gin.Context)

@Summary Delete an api key @Description Delete an api key @Tags framework/api-keys @Accept application/json @Success 200 @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /api-keys/:apiKeyId [delete]

func GetApiKeys

func GetApiKeys(c *gin.Context)

@Summary Get list of api keys @Description GET /api-keys?page=1&pageSize=10 @Tags framework/api-keys @Param page query int false "query" @Param pageSize query int false "query" @Success 200 {object} PaginatedApiKeys @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /api-keys [get]

func PostApiKey

func PostApiKey(c *gin.Context)

@Summary Create a new api key @Description Create a new api key @Tags framework/api-keys @Accept application/json @Param apikey body models.ApiInputApiKey true "json" @Success 200 {object} models.ApiOutputApiKey @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /api-keys [post]

func PutApiKey

func PutApiKey(c *gin.Context)

@Summary Refresh an api key @Description Refresh an api key @Tags framework/api-keys @Accept application/json @Success 200 @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /api-keys/:apiKeyId [put]

Types

type PaginatedApiKeys

type PaginatedApiKeys struct {
	ApiKeys []*models.ApiKey `json:"apikeys"`
	Count   int64            `json:"count"`
}