blueprints

package

v0.15.0 Latest Latest Go to latest Published: Jan 31, 2023 License: Apache-2.0, MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/apache/incubator-devlake

Links

Open Source Insights

Documentation ¶

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

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 ¶ added in v0.13.0

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 is_manual query bool false "is_manual" @Param page query int false "page" @Param page_size query int false "page_size" @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 ¶ added in v0.12.0

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" @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 ¶ added in v0.15.0

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

Source Files ¶

View all Source files

blueprints.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL