projects

Documentation

Index

• Constants
• func AccessList(c *gin.Context)
• func ActivityStream(c *gin.Context)
• func AddProject(c *gin.Context)
• func GetProject(c *gin.Context)
• func GetProjects(c *gin.Context)
• func Middleware(c *gin.Context)
• func PatchProject(c *gin.Context)
• func Playbooks(c *gin.Context)
• func ProjectUpdates(c *gin.Context)
• func RemoveProject(c *gin.Context)
• func SCMUpdate(c *gin.Context)
• func SCMUpdateInfo(c *gin.Context)
• func Teams(c *gin.Context)
• func UpdateProject(c *gin.Context)

Constants

const (
	CTXProject   = "project"
	CTXUser      = "user"
	CTXProjectID = "project_id"
)

Keys for project releated items stored in the Gin Context

Functions

func AccessList

func AccessList(c *gin.Context)

AccessList returns the list of teams and users that is able to access current project object in the gin context

func ActivityStream

func ActivityStream(c *gin.Context)

ActivityStream returns list of activities associated with project object that is in the gin.Context TODO: not complete

func AddProject

func AddProject(c *gin.Context)

AddProject is a Gin handler function which creates a new project using request payload. This accepts Project model.

func GetProject

func GetProject(c *gin.Context)

GetProject returns the project as a JSON object

func GetProjects

func GetProjects(c *gin.Context)

GetProjects returns a JSON array of projects

func Middleware

func Middleware(c *gin.Context)

Middleware generates a middleware handler function that works inside of a Gin request. This function takes CTXProjectID from Gin Context and retrieves project data from the collection and store credential data under key CTXProject in Gin Context

func PatchProject

func PatchProject(c *gin.Context)

PatchProject partially updates a project this only updates given files in the request playload

func Playbooks

func Playbooks(c *gin.Context)

Playbooks returs array of playbooks contains in project directory

func ProjectUpdates

func ProjectUpdates(c *gin.Context)

ProjectUpdates is a Gin handler function which returns project update jobs

func RemoveProject

func RemoveProject(c *gin.Context)

RemoveProject is a Gin handler function which removes a project object from the database

func SCMUpdate

func SCMUpdate(c *gin.Context)

SCMUpdate creates a new system job to update a project

func SCMUpdateInfo

func SCMUpdateInfo(c *gin.Context)

SCMUpdateInfo returns whether a project can be updated or not

func Teams

func Teams(c *gin.Context)

Teams returns the list of teams that has permission to access project object in the gin.Context

func UpdateProject

func UpdateProject(c *gin.Context)

UpdateProject is a Gin handler function which updates a project using request payload. This replaces all the fields in the database, empty "" fields and unspecified fields will be removed from the database object.