demo

Documentation

Index

• func AddLabel(c *gin.Context)
• func AddLabeling(c *gin.Context)
• func AddObject(c *gin.Context)
• func DeleteLabeling(c *gin.Context)
• func GetLabelingByLabelID(c *gin.Context)
• func GetLabelingByObjectID(c *gin.Context)
• func Label(c *gin.Context)
• func Object(c *gin.Context)
• func ReplaceLabeling(c *gin.Context)
• type AddLabelBody
• type AddLabelingBody
• type AddObjectBody
• type LabelQuery
• type ObjectQuery

Functions

func AddLabel

func AddLabel(c *gin.Context)

AddLabel godoc @Summary Add new label @Description give name and remark to add new label, return label ID, if label exist, update then remark field @Tags label @Accept json @Produce json @Param label body demo.AddLabelBody true "label info" @Router /demo/label [post] @Success 200 {object} response.Response

func AddLabeling

func AddLabeling(c *gin.Context)

AddLabeling godoc @Summary Labeling for object @Description create association for a given object ID list and tag ID list. @Tags labeling @Accept json @Produce json @Param labeling body demo.AddLabelingBody true "labeling association info" @Router /demo/labeling [post] @Success 200 {object} response.Response

func AddObject

func AddObject(c *gin.Context)

AddObject godoc @Summary Add new object @Description add new object return object ID @Tags object @Accept json @Produce json @Param object body demo.AddObjectBody true "object info" @Router /demo/object [post] @Success 200 {object} response.Response

func DeleteLabeling

func DeleteLabeling(c *gin.Context)

DeleteLabeling godoc @Summary Delete labeling @Description delete association for a given object ID list and tag ID list. @Tags labeling @Accept json @Produce json @Param labeling body demo.AddLabelingBody true "labeling association info" @Router /demo/labeling [delete] @Success 200 {object} response.Response

func GetLabelingByLabelID

func GetLabelingByLabelID(c *gin.Context)

GetLabelingByLabelID godoc @Summary Query labeling object list by label ID @Description return labeling object list @Tags labeling @Accept json @Produce json @Param id path uint true "label id" @Router /demo/labeling/label/{id} [get] @Success 200 {object} response.Response

func GetLabelingByObjectID

func GetLabelingByObjectID(c *gin.Context)

GetLabelingByObjectID godoc @Summary Query labeling label list by object ID @Description return labeling label list @Tags labeling @Accept json @Produce json @Param id path uint true "object id" @Router /demo/labeling/object/{id} [get] @Success 200 {object} response.Response

func Label

func Label(c *gin.Context)

Label godoc @Summary Query label by query params @Description query label by id or name, or paging query @Tags label @Accept json @Produce json @Param id query uint false "query by ID, other conditions do not enter into force." @Param name query string false "query by name, other conditions do not enter into force." @Param remark query string false "fuzzy query by remark" @Param pageNum query int false "page number" default(1) @Param pageSize query int false "page size" default(10) @Param order query string false "order field and order type" default(id asc) @Router /demo/label [get] @Success 200 {object} response.Response

func Object

func Object(c *gin.Context)

Object godoc @Summary Query object by params @Description query object by params @Tags object @Accept json @Produce json @Param id query uint false "query by object ID, other conditions do not enter into force." @Param appID query string false "filter result list by appid" @Param system query string false "filter result list by system" @Param entity query string false "filter result list by entity" @Param identity query string false "filter result list by identity" @Param pageNum query int false "page number" default(1) @Param pageSize query int false "page size" default(10) @Param order query string false "order field and way" default(id asc) @Router /demo/object [get] @Success 200 {object} response.Response

func ReplaceLabeling

func ReplaceLabeling(c *gin.Context)

ReplaceLabeling godoc @Summary Update labeling by replace way @Description replace association for a given object ID list and tag ID list. @Tags labeling @Accept json @Produce json @Param labeling body demo.AddLabelingBody true "labeling association info" @Router /demo/labeling [put] @Success 200 {object} response.Response

Types

type AddLabelBody

type AddLabelBody struct {
	// label name
	Name string `json:"name" binding:"required,max=32" example:"label name"`
	// label remark
	Remark string `json:"remark" binding:"max=64" example:"label remark"`
}

AddLabelBody use for bind json

type AddLabelingBody

type AddLabelingBody struct {
	// which object ids need to be labling with the label ids
	ObjectIDs []uint `json:"objectIDs" binding:"required"`
	// which label ids need to be labling with the object ids
	LabelIDs []uint `json:"labelIDs" binding:"required"`
}

AddLabelingBody bind for validator

type AddObjectBody

type AddObjectBody struct {
	// APP ID
	AppID string `json:"appID" binding:"required,max=16" example:"1"`
	// system name
	System string `json:"system" binding:"required,max=64" example:"cmdb"`
	// entity name
	Entity string `json:"entity" binding:"required,max=64" example:"server"`
	// identity
	Identity string `json:"identity" binding:"required,max=64" example:"1"`
}

AddObjectBody use for bind json

type LabelQuery

type LabelQuery struct {
	// label ID
	ID uint `form:"id"`
	// label name
	Name string `form:"name"`
	// label remark
	Remark string `form:"remark"`
	// page number
	PageNum int `form:"pageNum"`
	// page size
	PageSize int `form:"pageSize"`
	// how to order
	Order string `form:"order"`
}

LabelQuery use for bind query

type ObjectQuery

type ObjectQuery struct {
	// object ID
	ID uint `form:"id"`
	// APP ID
	AppID string `form:"appID"`
	// system name
	System string `form:"system"`
	// entity name
	Entity string `form:"entity"`
	// identity
	Identity string `form:"identity"`
	// page number
	PageNum int `form:"pageNum"`
	// page size
	PageSize int `form:"pageSize"`
	// order way
	Order string `form:"order"`
}

ObjectQuery use for bind query