desiredversioncontroller

Documentation

Overview

TODO: Describe package

Index

• func Create() gin.HandlerFunc
• func Delete() gin.HandlerFunc
• func GetAll() gin.HandlerFunc
• func GetByKey() gin.HandlerFunc
• func Update() gin.HandlerFunc

Functions

func Create

func Create() gin.HandlerFunc

TODO: Describe function

@Summary	Create a desired version
@Schemes
@Description	Create a desired version
@Tags			desired_version
@Accept			application/json
@Produce		application/json
@Param			version	body		apicontracts.DesiredVersion	true	"Add a desired version"
@Success		200		{string}	Ok
@Failure		403		{string}	Forbidden
@Failure		401		{string}	Unauthorized
@Failure		500		{string}	Failure	message
@Router			/v1/desired_versions [post]
@Security		ApiKey || AccessToken

func Delete

func Delete() gin.HandlerFunc

TODO: Describe function

@Summary	Delete a desired version by it's key
@Schemes
@Description	Delete a desired version by it's key
@Tags			desired_version
@Accept			application/json
@Produce		application/json
@Param			key	path		string	true	"key"
@Success		200	{string}	Ok
@Failure		403	{string}	Forbidden
@Failure		401	{string}	Unauthorized
@Failure		500	{string}	Failure	message
@Router			/v1/desired_versions/{key} [delete]
@Security		ApiKey || AccessToken

func GetAll

func GetAll() gin.HandlerFunc

TODO: Describe function

@Summary	Get all desired versions
@Schemes
@Description	Get all desired versions
@Tags			desired_version
@Accept			application/json
@Produce		application/json
@Success		200	{array}		[]apicontracts.DesiredVersion
@Failure		500	{string}	Failure	message
@Router			/v1/desired_versions [get]

func GetByKey

func GetByKey() gin.HandlerFunc

TODO: Describe function

@Summary	Get a desired version by its name
@Schemes
@Description	Get a desired version by its name
@Tags			desired_version
@Accept			application/json
@Produce		application/json
@Param			key	path		string	true	"key"
@Success		200	{object}	apicontracts.DesiredVersion
@Failure		500	{string}	Failure	message
@Router			/v1/desired_versions/{key} [get]

func Update

func Update() gin.HandlerFunc

TODO: Describe function

@Summary	Update a desired version by it's key
@Schemes
@Description	Update a desired version by it's key
@Tags			desired_version
@Accept			application/json
@Produce		application/json
@Param			key		path		string						true	"key"
@Param			version	body		apicontracts.DesiredVersion	true	"Update the desired version"
@Success		200		{string}	Ok
@Failure		403		{string}	Forbidden
@Failure		401		{string}	Unauthorized
@Failure		500		{string}	Failure	message
@Router			/v1/desired_versions/{key} [put]
@Security		ApiKey || AccessToken