blueprints

Documentation

Index

• func Delete(c *gin.Context)
• func Get(c *gin.Context)
• func GetBlueprintPipelines(c *gin.Context)
• func Index(c *gin.Context)
• func Patch(c *gin.Context)
• func Post(c *gin.Context)
• func Trigger(c *gin.Context)
• type PaginatedBlueprint

Functions

func Delete

func Delete(c *gin.Context)

@Summary delete blueprint by id @Description delete blueprint by id @Tags framework/blueprints @Accept application/json @Param blueprintId path int true "blueprint id" @Success 200 @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /blueprints/{blueprintId} [delete]

func Get

func Get(c *gin.Context)

@Summary get blueprints @Description get blueprints @Tags framework/blueprints @Accept application/json @Param blueprintId path int true "blueprint id" @Success 200 {object} models.Blueprint @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /blueprints/{blueprintId} [get]

func GetBlueprintPipelines

func GetBlueprintPipelines(c *gin.Context)

@Summary get pipelines by blueprint id @Description get pipelines by blueprint id @Tags framework/blueprints @Accept application/json @Param blueprintId path int true "blueprint id" @Success 200 {object} shared.ResponsePipelines @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /blueprints/{blueprintId}/pipelines [get]

func Index

func Index(c *gin.Context)

@Summary get blueprints @Description get blueprints @Tags framework/blueprints @Param enable query bool false "enable" @Param isManual query bool false "isManual" @Param page query int false "page" @Param pageSize query int false "pageSize" @Param label query string false "label" @Success 200 {object} PaginatedBlueprint @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /blueprints [get]

func Patch

func Patch(c *gin.Context)

@Summary patch blueprints @Description patch blueprints @Tags framework/blueprints @Accept application/json @Param blueprintId path string true "blueprintId" @Success 200 {object} models.Blueprint @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /blueprints/{blueprintId} Patch

func Post

func Post(c *gin.Context)

@Summary post blueprints @Description post blueprints @Tags framework/blueprints @Accept application/json @Param blueprint body models.Blueprint true "json" @Success 200 {object} models.Blueprint @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /blueprints [post]

func Trigger

func Trigger(c *gin.Context)

@Summary trigger blueprint @Description trigger a blueprint immediately @Tags framework/blueprints @Accept application/json @Param blueprintId path string true "blueprintId" @Param skipCollectors body bool false "skipCollectors" @Success 200 {object} models.Pipeline @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /blueprints/{blueprintId}/trigger Post

Types

type PaginatedBlueprint

type PaginatedBlueprint struct {
	Blueprints []*models.Blueprint `json:"blueprints"`
	Count      int64               `json:"count"`
}