Documentation
¶
Index ¶
- func AcceptTermsAndConditions(c *gin.Context)
- func AddCapacity(capacity models.Capacity, catalogCapacity pac.Capacity) (models.Capacity, error)
- func ApproveRequest(c *gin.Context)
- func CreateCatalog(c *gin.Context)
- func CreateFeedback(c *gin.Context)
- func CreateKey(c *gin.Context)
- func CreateQuota(c *gin.Context)
- func CreateService(c *gin.Context)
- func DeleteCatalog(c *gin.Context)
- func DeleteKeyHandler(c *gin.Context)
- func DeleteQuota(c *gin.Context)
- func DeleteRequest(c *gin.Context)
- func DeleteServiceHandler(c *gin.Context)
- func DeleteUser(c *gin.Context)
- func ExitGroup(c *gin.Context)
- func ExpiryNotification()
- func GetAllCatalogs(c *gin.Context)
- func GetAllGroups(c *gin.Context)
- func GetAllKeysHandler(c *gin.Context)
- func GetAllRequests(c *gin.Context)
- func GetAllServicesHandler(c *gin.Context)
- func GetCatalog(c *gin.Context)
- func GetEvents(c *gin.Context)
- func GetFeedback(c *gin.Context)
- func GetGroup(c *gin.Context)
- func GetKey(c *gin.Context)
- func GetQuota(c *gin.Context)
- func GetRequest(c *gin.Context)
- func GetService(c *gin.Context)
- func GetTermsAndConditionsStatus(c *gin.Context)
- func GetUser(c *gin.Context)
- func GetUserQuota(c *gin.Context)
- func GetUsers(c *gin.Context)
- func NewGroupRequest(c *gin.Context)
- func RejectRequest(c *gin.Context)
- func RetireCatalog(c *gin.Context)
- func SetDB(db db.DB)
- func SetKubeClient(client kubernetes.Client)
- func UpdateQuota(c *gin.Context)
- func UpdateServiceExpiryRequest(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AcceptTermsAndConditions ¶ added in v0.3.2
AcceptTermsAndConditions godoc @Summary Accept terms and conditions @Description Accept terms and conditions @Tags tnc @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/tnc [post]
func AddCapacity ¶
func ApproveRequest ¶
ApproveRequest godoc @Summary Approve request @Description Approve request @Tags requests @Accept json @Produce json @Param id path string true "request-id for the request to be approved" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/requests/{id}/approve [post]
func CreateCatalog ¶
CreateCatalog godoc @Summary Create catalog @Description Create catalog resource @Tags catalogs @Accept json @Produce json @Param catalog body models.Catalog true "Create catalog" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/catalogs [post]
func CreateFeedback ¶ added in v0.5.0
CreateFeedback godoc @Summary Create Feedback given by user @Description Create feedback resource @Tags feedbacks @Accept json @Produce json @Param feedback body models.Feedback true "Create feedback" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/feedbacks [post]
func CreateKey ¶
CreateKey godoc @Summary Create key @Description Create key @Tags keys @Accept json @Produce json @Param key body models.Key true "Create key" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/keys [post]
func CreateQuota ¶
CreateQuota godoc @Summary Create quota @Description Create quota @Tags quota @Accept json @Produce json @Param quota body models.Quota true "Create quota" @Param id path string true "group-id where quota has to be created" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/groups/{id}/quota [post]
func CreateService ¶
CreateService godoc @Summary Create service @Description Create service @Tags services @Accept json @Produce json @Param service body models.Service true "Create service" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1//services [post]
func DeleteCatalog ¶
DeleteCatalog godoc @Summary Delete catalog @Description Delete catalog resource @Tags catalogs @Accept json @Produce json @Param name path string true "catalog name to be deleted" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/catalogs/{name} [delete]
func DeleteKeyHandler ¶ added in v0.4.1
DeleteKey godoc @Summary Delete key @Description Delete key @Tags keys @Accept json @Produce json @Param id path string true "key-id to be deleted" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/keys/{id} [delete]
func DeleteQuota ¶
DeleteQuota godoc @Summary Delete quota @Description Delete quota @Tags quota @Accept json @Produce json @Param id path string true "group-id where quota has to be deleted" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/groups/{id}/quota [delete]
func DeleteRequest ¶
DeleteRequest godoc @Summary Delete request @Description Delete request @Tags requests @Accept json @Produce json @Param id path string true "request-id for the request to be deleted" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/requests/{id} [delete]
func DeleteServiceHandler ¶ added in v0.4.1
DeleteService godoc @Summary Delete service @Description Delete service @Tags services @Accept json @Produce json @Param name path string true "service name to be deleted" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/services/{name} [delete]
func DeleteUser ¶ added in v0.4.1
func ExitGroup ¶
ExitGroup godoc @Summary Exit group request @Description Request to exit from group @Tags requests @Accept json @Produce json @Param id path string true "group-id for the group to be exited from" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/groups/{id}/exit [post]
func ExpiryNotification ¶ added in v0.4.0
func ExpiryNotification()
ExpiryNotification raises notification for about-to-expire services
func GetAllCatalogs ¶
GetAllCatalogs godoc @Summary Get all catalogs @Description Get all catalogs resource @Tags catalogs @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/catalogs [get]
func GetAllGroups ¶
GetAllGroups godoc @Summary Get all groups @Description Get all groups @Tags groups @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/groups [get]
func GetAllKeysHandler ¶ added in v0.4.1
GetAllKeys godoc @Summary Get all keys @Description Get all keys @Tags keys @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/keys [get] Get the Key values and update.
func GetAllRequests ¶
GetAllRequests godoc @Summary Get all requests @Description Get all requests @Tags requests @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/requests [get]
func GetAllServicesHandler ¶ added in v0.4.1
GetAllServices godoc @Summary Get all services @Description Get all services @Tags services @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/services [get]
func GetCatalog ¶
GetCatalog godoc @Summary Get catalog as specified in request @Description Get catalog resource @Tags catalogs @Accept json @Produce json @Param name path string true "catalog name to be fetched" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/catalogs/{name} [get]
func GetEvents ¶ added in v0.3.0
GetEvents godoc @Summary Get events @Description Get events @Tags events @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/events [get] GetEvents returns all events
func GetFeedback ¶ added in v0.5.0
GetFeedback godoc @Summary Get feedbacks submitted by users @Description Get feedback resource @Tags feedbacks @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Param page query int false "Page number for pagination" @Param per_page query int false "Number of items per page" @Success 200 @Router /api/v1/feedbacks [get]
func GetGroup ¶
GetGroup godoc @Summary Get group @Description Get group as specified in request @Tags groups @Accept json @Produce json @Param id path string true "group-id to be fetched" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/groups/{id} [get]
func GetKey ¶
GetKey godoc @Summary Get key @Description Get key @Tags keys @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Param id path string true "key-id to be fetched" @Success 200 @Router /api/v1/keys/{id} [get]
func GetQuota ¶
GetQuota godoc @Summary Get quota @Description Get quota @Tags quota @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Param id path string true "group-id to be fetched" @Success 200 @Router /api/v1/groups/{id}/quota [get] Get the respective quota of the group ID passed.
func GetRequest ¶
GetRequest godoc @Summary Get request @Description Get request @Tags requests @Accept json @Produce json @Param id path string true "request-id for request to be fetched" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/requests/{id} [get]
func GetService ¶
GetService godoc @Summary Get service @Description Get service @Tags services @Accept json @Produce json @Param name path string true "service name" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/services/{name} [get]
func GetTermsAndConditionsStatus ¶ added in v0.3.2
GetTermsAndConditionsStatus godoc @Summary Get terms and conditions @Description Get terms and conditions @Tags tnc @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/tnc [get]
func GetUser ¶
GetUser godoc @Summary Get user @Description Get user based on given id @Tags user @Accept json @Produce json @Param id path string true "user-id for user to be fetched" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/users/{id} [get]
func GetUserQuota ¶
GetUserQuota godoc @Summary Get user quota @Description Get user quota @Tags quota @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/quota [get]
func GetUsers ¶
GetUsers godoc @Summary Get all users @Description Get all users @Tags user @Accept json @Produce json @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/users [get]
func NewGroupRequest ¶
NewGroupRequest godoc @Summary New group request @Description Request to switch to new group @Tags requests @Accept json @Produce json @Param id path string true "group-id for the requested group" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/groups/{id}/request [post]
func RejectRequest ¶
RejectRequest godoc @Summary Reject request @Description Reject request @Tags requests @Accept json @Produce json @Param id path string true "request-id for the request to be rejected" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/requests/{id}/reject [post]
func RetireCatalog ¶
RetireCatalog godoc @Summary Reire catalog @Description Reire catalog resource @Tags catalogs @Accept json @Produce json @Param name path string true "catalog name to be retired" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/catalogs/{name}/retire [put]
func SetKubeClient ¶
func SetKubeClient(client kubernetes.Client)
func UpdateQuota ¶
UpdateQuota godoc @Summary Update quota @Description Update quota @Tags quota @Accept json @Produce json @Param quota body models.Quota true "Update quota" @Param id path string true "group-id where quota has to be updated" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/groups/{id}/quota [put]
func UpdateServiceExpiryRequest ¶
UpdateServiceExpiryRequest godoc @Summary Update service expiry request @Description Update service expiry for a particular service @Tags requests @Accept json @Produce json @Param name path string true "service name" @Param Authorization header string true "Insert your access token" default(Bearer <Add access token here>) @Success 200 @Router /api/v1/services/{name}/expiry [put]
Types ¶
This section is empty.