Documentation
¶
Index ¶
- func BatchReleaseMethod(c *gin.Context)
- func BatchReleasePluginGroup(c *gin.Context)
- func BatchReleaseResource(c *gin.Context)
- func CreateCluster(c *gin.Context)
- func CreateListener(c *gin.Context)
- func CreateMethodInfo(c *gin.Context)
- func CreateResourceInfo(c *gin.Context)
- func DeleteCluster(c *gin.Context)
- func DeleteListener(c *gin.Context)
- func DeleteMethodInfo(c *gin.Context)
- func DeleteResourceInfo(c *gin.Context)
- func DetailCluster(c *gin.Context)
- func DetailListener(c *gin.Context)
- func GetBaseInfo(c *gin.Context)
- func GetClusterList(c *gin.Context)
- func GetListenerList(c *gin.Context)
- func GetMethodDetail(c *gin.Context)
- func GetMethodList(c *gin.Context)
- func GetResourceDetail(c *gin.Context)
- func GetResourceList(c *gin.Context)
- func ModifyMethodInfo(c *gin.Context)
- func ModifyResourceInfo(c *gin.Context)
- func SetBaseInfo(c *gin.Context)
- func UpdateCluster(c *gin.Context)
- func UpdateListener(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BatchReleaseMethod ¶
@Tags Config @Summary batch Release Method Config @Description TODO: unimplemented @Produce application/json @Success 200 {object} string @Router /config/api/resource/method/publish [put] BatchReleaseMethod Batch Release Method Config
func BatchReleasePluginGroup ¶
@Tags Config @Summary batch Release PluginGroup Config @Description publish the PluginGroup from the unpublished space to the published space. @Produce application/json @Success 200 {object} string @Router /config/api/plugin_group/publish [put] BatchReleasePluginGroup Batch Release PluginGroup Config
func BatchReleaseResource ¶
@Tags Config @Summary publish all configuration information @Description publish resources from unpublished spaces to published spaces @Produce application/json @Success 200 {object} string @Router /config/api/resource/publish [put] BatchReleaseResource Publish all configuration information
func CreateCluster ¶
@Tags Config @Summary create cluster @Description Create a cluster by passing the YAML/JSON configuration for the cluster through the form's content field. @Accept application/x-www-form-urlencoded @Produce application/json @Param content formData string true "Cluster content" @Success 200 {object} string @Failure 200 {object} string @Router /config/api/cluster [put] CreateCluster create a cluster
func CreateListener ¶
@Tags Config @Summary create a Listener @Description pass the YAML/JSON for the Listener through the form's content field to create the Listener. @Accept application/x-www-form-urlencoded @Produce application/json @Param content formData string true "Listener content" @Success 200 {object} string @Failure 200 {object} string @Router /config/api/listener [put] CreateListener create a Listener
func CreateMethodInfo ¶
@Tags Config @Summary create method @Description create a method under the specified resource, where content is the YAML for Method. @Accept application/x-www-form-urlencoded @Produce application/json @Param resourceId query int true "ResourceID" @Param content formData string true "Method YAML" @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {object} string @Router /config/api/resource/method [post] CreateMethodInfo create method
func CreateResourceInfo ¶
@Tags Config @Summary create resource @Description create a resource by passing the Resource's YAML via the form's content field (simultaneously writing to the staging area and production area). @Accept application/x-www-form-urlencoded @Produce application/json @Param content formData string true "Resource YAML" @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {object} string @Failure 200 {object} string @Router /config/api/resource [post] CreateResourceInfo create resource
func DeleteCluster ¶
@Tags Config @Summary delete cluster @Description delete cluster according to cluster ID @Produce application/json @Param id query string true "Cluster ID" @Success 200 {object} string @Router /config/api/cluster [delete] DeleteCluster delete resource
func DeleteListener ¶
@Tags Config @Summary delete Listener @Description delete the Listener based on the name @Produce application/json @Param name query string true "Listener id" @Success 200 {object} string @Router /config/api/listener [delete] DeleteListener delete Listener
func DeleteMethodInfo ¶
@Tags Config @Summary delete method @Description Deleting a method under a resource, where `unpublished` equals 1 indicates removing the configuration for unpublished spaces (requires checking published spaces). @Produce application/json @Param resourceId query int true "ResourceID" @Param methodId query int true "MethodID" @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {object} string @Router /config/api/resource/method [delete] DeleteResourceInfo delete method
func DeleteResourceInfo ¶
@Tags Config @Summary delete resource @Description delete resources by ID. When unpublished is 1, this indicates deleting configurations for unpublished spaces (requires checking published spaces). @Produce application/json @Param resourceId query int true "resource ID" @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {object} string @Router /config/api/resource [delete] DeleteResourceInfo delete resource
func DetailCluster ¶
@Tags Config @Summary get cluster detail @Description get cluster detail according to cluster ID @Produce application/json @Param id query string true "Cluster ID" @Success 200 {object} string @Router /config/api/cluster/detail [get] DetailCluster get cluster detail
func DetailListener ¶
@Tags Config @Summary get Listener detail @Description get Listener details based on name @Produce application/json @Param name query string true "Listener name" @Success 200 {object} string @Router /config/api/listener/detail [get] DetailListener get Listener detail
func GetBaseInfo ¶
@Tags Config @Summary get basic configuration of Pixiu @Description get pixiu base info such as name,desc @Produce application/json @Success 200 {string} string "YAML content" @Router /config/api/base [get] GetBaseInfo get pixiu base info such as name,desc
func GetClusterList ¶
@Tags Config @Summary get cluster list @Description get all clusters' info @Produce application/json @Success 200 {object} string @Router /config/api/cluster/list [get] GetClusterList get all cluster list
func GetListenerList ¶
@Tags Config @Summary get all Listener list @Description get all Listener list @Produce application/json @Success 200 {object} string @Router /config/api/listener/list [get] GetListenerList get all Listener list
func GetMethodDetail ¶
@Tags Config @Summary get method detail with yml @Description get method details based on resourceId and methodId, returning YAML. @Produce application/json @Param resourceId query int true "resource ID" @Param methodId query int true "method ID" @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {string} string "YAML content" @Router /config/api/resource/method/detail [get] GetMethodDetail get method detail with yml
func GetMethodList ¶
@Tags Config @Summary get all method list below one resource @Description get the list of methods under the specified resource @Produce application/json @Param resourceId query int true "resource ID" @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {string} string "JSON array" @Router /config/api/resource/method/list [get] GetMethodList get all method list below one resource
func GetResourceDetail ¶
@Tags Config @Summary get resource detail with yml @Description get resource details according to resource ID and return the YAML @Produce application/json @Param resourceId query int true "ResourceID" @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {string} string "YAML content" @Router /config/api/resource/detail [get] GetResourceDetail get resource detail with yml
func GetResourceList ¶
@Tags Config @Summary get all resource list @Description Retrieve the list of resources. Use the unpublished parameter to control whether to include unpublished or published resources. @Produce application/json @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {string} string "JSON array" @Router /config/api/resource/list [get] GetResourceList get all resource list
func ModifyMethodInfo ¶
@Tags Config @Summary modify method @Description Modify the specified method, where content is the YAML for Method. @Accept application/x-www-form-urlencoded @Produce application/json @Param resourceId query int true "ResourceID" @Param methodId query int false "MethodID" @Param content formData string true "Method YAML" @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {object} string @Router /config/api/resource/method [put] ModifyMethodInfo modify method
func ModifyResourceInfo ¶
@Tags Config @Summary modify resource @Description modify resource content, where content is the YAML of the Resource. Use resourceId to specify the resource to be modified. @Accept application/x-www-form-urlencoded @Produce application/json @Param resourceId query int false "resource ID" @Param content formData string true "Resource YAML" @Param unpublished formData string false "1: unpublished; 0 or empty: published" @Success 200 {object} string @Router /config/api/resource [put] ModifyResourceInfo modify resource
func SetBaseInfo ¶
@Tags Config @Summary modify pixiu base info such as name,desc @Description Pass YAML content through the form's content field to set basic information. @Accept application/x-www-form-urlencoded @Produce application/json @Param content formData string true "YAML content" @Success 200 {object} string @Failure 200 {object} string @Router /config/api/base/ [post] @Router /config/api/base/ [put] SetBaseInfo modify pixiu base info such as name,desc
func UpdateCluster ¶
@Tags Config @Summary update cluster @Description pass the Cluster's YAML/JSON via the form's content field to update the cluster. @Accept application/x-www-form-urlencoded @Produce application/json @Param content formData string true "Cluster content" @Success 200 {object} string @Failure 200 {object} string @Router /config/api/cluster [post] UpdateCluster update cluster
func UpdateListener ¶
@Tags Config @Summary update Listener @Description pass the YAML/JSON for the Listener through the form's content field to update the Listener. @Accept application/x-www-form-urlencoded @Produce application/json @Param content formData string true "Listener content" @Success 200 {object} string @Failure 200 {object} string @Router /config/api/listener [post] UpdateListener update Listener
Types ¶
This section is empty.
Source Files