github.com/polarismesh/polaris@v1.17.8/apiserver/httpserver/docs/naming_console_access_apidoc.go

/**
 * Tencent is pleased to support the open source community by making Polaris available.
 *
 * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
 *
 * Licensed under the BSD 3-Clause License (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://opensource.org/licenses/BSD-3-Clause
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package docs

import (
	"github.com/emicklei/go-restful/v3"
	restfulspec "github.com/polarismesh/go-restful-openapi/v2"
	"github.com/polarismesh/specification/source/go/api/v1/fault_tolerance"
	apifault "github.com/polarismesh/specification/source/go/api/v1/fault_tolerance"
	apimodel "github.com/polarismesh/specification/source/go/api/v1/model"
	"github.com/polarismesh/specification/source/go/api/v1/service_manage"
	apiservice "github.com/polarismesh/specification/source/go/api/v1/service_manage"
	"github.com/polarismesh/specification/source/go/api/v1/traffic_manage"
	apitraffic "github.com/polarismesh/specification/source/go/api/v1/traffic_manage"
)

var (
	namespacesApiTags          = []string{"Namespaces"}
	servicesApiTags            = []string{"Services"}
	instancesApiTags           = []string{"Instances"}
	routingRulesApiTags        = []string{"RoutingRules"}
	rateLimitsApiTags          = []string{"RateLimits"}
	circuitBreakersApiTags     = []string{"CircuitBreakers"}
	circuitBreakerRulesApiTags = []string{"CircuitBreakerRules"}
	faultDetectsApiTags        = []string{"FaultDetects"}
)

const (
	typeNameString  = "string"
	typeNameInteger = "integer"
	typeNameBool    = "boolean"
)

func EnrichGetNamespacesApiDocsOld(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("获取命名空间列表(Old)").
		Metadata(restfulspec.KeyOpenAPITags, namespacesApiTags).
		Param(restful.QueryParameter("name", "命名空间唯一名称").
			DataType(typeNameString).Required(true)).
		Param(restful.QueryParameter("offset", "查询偏移量").
			DataType(typeNameInteger).Required(false).DefaultValue("0")).
		Param(restful.QueryParameter("limit", "查询条数，**最多查询100条**").
			DataType(typeNameInteger).Required(false)).
		Returns(0, "", struct {
			BatchQueryResponse
			Namespaces []apimodel.Namespace `json:"namespaces"`
		}{})
}

func EnrichCreateNamespacesApiDocsOld(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("创建命名空间(Old)").
		Metadata(restfulspec.KeyOpenAPITags, namespacesApiTags).
		Reads([]apimodel.Namespace{}, "create namespaces").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Namespace apimodel.Namespace `json:"namespace"`
			} `json:"responses"`
		}{})
}

func EnrichDeleteNamespacesApiDocsOld(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("删除命名空间(Old)").
		Metadata(restfulspec.KeyOpenAPITags, namespacesApiTags).
		Reads([]apimodel.Namespace{}, "delete namespaces").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Namespace apimodel.Namespace `json:"namespace"`
			} `json:"responses"`
		}{})
}

func EnrichUpdateNamespacesApiDocsOld(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("更新命名空间(Old)").
		Metadata(restfulspec.KeyOpenAPITags, namespacesApiTags).
		Reads([]apimodel.Namespace{}, "update namespaces").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Namespace apimodel.Namespace `json:"namespace"`
			} `json:"responses"`
		}{})
}

func EnrichGetNamespaceTokenApiDocsOld(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("查询命名空间Token(Old)").
		Metadata(restfulspec.KeyOpenAPITags, namespacesApiTags).Deprecate()
}

func EnrichUpdateNamespaceTokenApiDocsOld(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("更新命名空间Token(Old)").
		Metadata(restfulspec.KeyOpenAPITags, namespacesApiTags).Deprecate()
}

func EnrichGetAllServicesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("获取全部服务列表").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Param(restful.QueryParameter("namespace", "命名空间").DataType(typeNameString).
			Required(false)).
		Returns(0, "", struct {
			BatchQueryResponse
			Services []service_manage.Service `json:"services"`
		}{})
}

func EnrichGetServicesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("获取服务列表").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Param(restful.QueryParameter("name", "服务名, 前缀查询: name*; 后缀查询: *name; 全模糊查询: *name*").
			DataType(typeNameString).
			Required(false).
			DefaultValue("demo-service")).
		Param(restful.QueryParameter("namespace", "命名空间, 前缀查询: name*; 后缀查询: *name; 全模糊查询: *name*").
			DataType(typeNameString).
			Required(false).
			DefaultValue("default")).
		Param(restful.QueryParameter("business", "业务，默认模糊查询").DataType(typeNameString).
			Required(false)).
		Param(restful.QueryParameter("department", "部门").DataType(typeNameString).
			Required(false)).
		Param(restful.QueryParameter("host", "实例IP，**多个IP以英文逗号分隔**").
			DataType(typeNameString).Required(false)).
		Param(restful.QueryParameter("port", "**实例端口**，**多个端口以英文逗号分隔** ").
			DataType(typeNameString).Required(false)).
		Param(restful.QueryParameter("keys", "服务元数据名，keys和values需要同时填写，"+
			"目前只支持查询一组元数据。").DataType(typeNameString).Required(false)).
		Param(restful.QueryParameter("values", "服务元数据名，keys和values需要同时填写，"+
			"目前只支持查询一组元数据。").DataType(typeNameString).Required(false)).
		Param(restful.QueryParameter("instance_keys", "实例标签key, key-1,key-2, instance_keys 和 "+
			" instance_values 需要同时填写且必须元素个数一致").DataType(typeNameString).
			Required(false).DefaultValue("")).
		Param(restful.QueryParameter("instance_values", "实例标签value, value-1,value-2, instance_keys "+
			" 和 instance_values 需要同时填写且必须元素个数一致").
			DataType(typeNameString).
			Required(false)).
		Param(restful.QueryParameter("offset", "查询偏移量").DataType(typeNameInteger).
			Required(false).DefaultValue("0")).
		Param(restful.QueryParameter("limit", "查询条数，**最多查询100条**").DataType(typeNameInteger).
			Required(false)).
		Returns(0, "", struct {
			BatchQueryResponse
			Services []service_manage.Service `json:"services"`
		}{})
}

func EnrichCreateServicesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("创建服务").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Reads([]apiservice.Service{}, "create services").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Service service_manage.Service `json:"service"`
			} `json:"responses"`
		}{})
}

func EnrichDeleteServicesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("删除服务").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Reads([]apiservice.Service{}, "delete services").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Service service_manage.Service `json:"service"`
			} `json:"responses"`
		}{})
}

func EnrichUpdateServicesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("更新服务").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Reads([]apiservice.Service{}, "update services").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Service service_manage.Service `json:"service"`
			} `json:"responses"`
		}{})
}

func EnrichGetServicesCountApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("获取服务数量").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Returns(0, "", BatchQueryResponse{})
}

func EnrichGetServiceTokenApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.
		Doc("查询服务Token").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).Deprecate()
}

func EnrichUpdateServiceTokenApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("更新服务Token").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).Deprecate()
}

func EnrichCreateServiceAliasApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("创建服务别名").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Reads(apiservice.ServiceAlias{}, "create service alias").
		Returns(0, "", BaseResponse{})
}

func EnrichUpdateServiceAliasApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("更新服务别名").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Reads(apiservice.ServiceAlias{}, "update service alias").
		Returns(0, "", BaseResponse{})
}

func EnrichGetServiceAliasesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("查询服务别名").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Param(restful.QueryParameter("alias", "服务别名").
			DataType(typeNameString).Required(false).DefaultValue("demo-service")).
		Param(restful.QueryParameter("alias_namespace", "服务别名命名空间").
			DataType(typeNameString).Required(false).DefaultValue("demo-service")).
		Param(restful.QueryParameter("service", "原服务名").
			DataType(typeNameString).Required(false).DefaultValue("demo-service")).
		Param(restful.QueryParameter("namespace", "原服务命名空间").
			DataType(typeNameString).Required(false).DefaultValue("demo-service")).
		Param(restful.QueryParameter("offset", "查询偏移量").DataType(typeNameInteger).
			Required(false).DefaultValue("0")).
		Param(restful.QueryParameter("limit", "查询条数，**最多查询100条**").DataType(typeNameInteger).
			Required(false)).
		Returns(0, "", struct {
			BatchQueryResponse
			Services []service_manage.Service `json:"services"`
		}{})
}

func EnrichDeleteServiceAliasesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("删除服务别名").
		Metadata(restfulspec.KeyOpenAPITags, servicesApiTags).
		Reads([]apiservice.ServiceAlias{}, "delete service aliases").
		Returns(0, "", BaseResponse{})
}

func EnrichCreateInstancesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("创建实例").
		Metadata(restfulspec.KeyOpenAPITags, instancesApiTags).
		Reads([]apiservice.Instance{}, "create instances").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Instance service_manage.Instance `json:"instance"`
			} `json:"responses"`
		}{})
}

func EnrichDeleteInstancesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("删除实例(根据实例ID)").
		Metadata(restfulspec.KeyOpenAPITags, instancesApiTags).
		Reads([]apiservice.Instance{}, "delete instances").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Instance service_manage.Instance `json:"instance"`
			} `json:"responses"`
		}{})
}

func EnrichDeleteInstancesByHostApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("删除实例(根据主机)").
		Metadata(restfulspec.KeyOpenAPITags, instancesApiTags).
		Reads([]apiservice.Instance{}, "delete instances").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Instance service_manage.Instance `json:"instance"`
			} `json:"responses"`
		}{})
}

func EnrichUpdateInstancesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("更新实例").
		Metadata(restfulspec.KeyOpenAPITags, instancesApiTags).
		Reads([]apiservice.Instance{}, "update instances").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Instance service_manage.Instance `json:"instance"`
			} `json:"responses"`
		}{})
}

func EnrichUpdateInstancesIsolateApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("修改服务实例的隔离状态").
		Metadata(restfulspec.KeyOpenAPITags, instancesApiTags).
		Reads([]apiservice.Instance{}, "update instances").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
				Instance service_manage.Instance `json:"instance"`
			} `json:"responses"`
		}{})
}

func EnrichGetInstancesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("查询服务实例").
		Metadata(restfulspec.KeyOpenAPITags, instancesApiTags).
		Param(restful.PathParameter("id", "实例ID").
			DataType(typeNameString).Required(false)).
		Param(restful.QueryParameter("service", "service namespace host 三个必须最少传一个, "+
			" 前缀查询: name*; 后缀查询: *name; 全模糊查询: *name*").
			DataType(typeNameString).Required(false)).
		Param(restful.QueryParameter("namespace", "service namespace host 三个必须最少传一个, "+
			" 前缀查询: name*; 后缀查询: *name; 全模糊查询: *name*").
			DataType(typeNameString).Required(false)).
		Param(restful.QueryParameter("host", "service namespace host 三个必须最少传一个").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("keys", "标签key").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("values", "标签value").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("healthy", "实例健康状态").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("isolate", "实例隔离状态").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("protocol", "实例端口协议状态").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("version", "实例版本").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("cmdb_region", "实例region信息").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("cmdb_zone", "实例zone信息").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("cmdb_idc", "实例idc信息").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("offset", "查询偏移量").
			DataType(typeNameInteger).Required(false)).
		Param(restful.PathParameter("limit", "查询条数").
			DataType(typeNameInteger).Required(false)).
		Returns(0, "", struct {
			BatchQueryResponse
			Instances []service_manage.Instance `json:"instances"`
		}{})
}

func EnrichGetInstancesCountApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("查询服务实例数量").
		Metadata(restfulspec.KeyOpenAPITags, instancesApiTags).
		Returns(0, "", BatchQueryResponse{})
}

func EnrichGetInstanceLabelsApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("查询某个服务下所有实例的标签信息").
		Metadata(restfulspec.KeyOpenAPITags, instancesApiTags).
		Param(restful.QueryParameter("service", "服务名称").
			DataType(typeNameString).Required(true)).
		Param(restful.QueryParameter("namespace", "命名空间").
			DataType(typeNameString).Required(true)).
		Returns(0, "", struct {
			BaseResponse
			InstanceLabels service_manage.InstanceLabels `json:"instanceLabels,omitempty"`
		}{})
}

func EnrichCreateRateLimitsApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("创建限流规则").
		Metadata(restfulspec.KeyOpenAPITags, rateLimitsApiTags).
		Reads([]apitraffic.Rule{}, "create rate limits").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichDeleteRateLimitsApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("删除限流规则").
		Metadata(restfulspec.KeyOpenAPITags, rateLimitsApiTags).
		Reads([]apitraffic.Rule{}, "delete rate limits").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichUpdateRateLimitsApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("更新限流规则").
		Metadata(restfulspec.KeyOpenAPITags, rateLimitsApiTags).
		Reads([]apitraffic.Rule{}, "update rate limits").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichGetRateLimitsApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("查询限流规则").
		Metadata(restfulspec.KeyOpenAPITags, rateLimitsApiTags).
		Param(restful.PathParameter("id", "规则ID").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("name", "规则名称").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("service", "服务名称").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("namespace", "命名空间").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("method", "限流接口名，默认为模糊匹配 ").
			DataType(typeNameString).Required(false)).
		Param(restful.PathParameter("disable", "规则是否启用，true为不启用，false为启用").
			DataType(typeNameBool).Required(false)).
		Param(restful.PathParameter("brief",
			"是否只显示概要信息，brief=true时，只返回规则列表概要信息，默认为false").
			DataType("boolean").Required(false).DefaultValue("false")).
		Param(restful.PathParameter("offset", "分页的起始位置，默认为0").DataType(typeNameInteger).
			Required(false).DefaultValue("0")).
		Param(restful.PathParameter("limit", "每页行数，默认100  ").DataType(typeNameInteger).
			Required(false).DefaultValue("100")).
		Returns(0, "", struct {
			BatchQueryResponse
			RateLimits []traffic_manage.Rule `json:"rateLimits,omitempty"`
		}{})
}

func EnrichEnableRateLimitsApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("启用限流规则").
		Metadata(restfulspec.KeyOpenAPITags, rateLimitsApiTags).
		Reads([]apitraffic.Rule{}, "enable rate limits").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichCreateCircuitBreakerRulesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("创建熔断规则").
		Metadata(restfulspec.KeyOpenAPITags, circuitBreakersApiTags).
		Reads([]apifault.CircuitBreakerRule{}, "create circuitbreaker rules").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichDeleteCircuitBreakerRulesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("删除熔断规则").
		Metadata(restfulspec.KeyOpenAPITags, circuitBreakersApiTags).
		Reads([]apifault.CircuitBreakerRule{}, "delete circuitbreaker rules").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichUpdateCircuitBreakerRulesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("更新熔断规则").
		Metadata(restfulspec.KeyOpenAPITags, circuitBreakersApiTags).
		Reads([]apifault.CircuitBreakerRule{}, "update circuitbreaker rules").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichGetCircuitBreakerRulesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("查询熔断规则").
		Metadata(restfulspec.KeyOpenAPITags, circuitBreakersApiTags).
		Param(restful.PathParameter("brief", "是否只显示概要信息，brief=true时，则不返回规则详情，"+
			"只返回规则列表概要信息，默认为false").DataType(typeNameBool).
			Required(false).DefaultValue("false")).
		Param(restful.PathParameter("offset", "分页的起始位置，默认为0").DataType(typeNameInteger).
			Required(false).DefaultValue("0")).
		Param(restful.PathParameter("limit", "每页行数，默认100  ").DataType(typeNameInteger).
			Required(false).DefaultValue("100")).
		Param(restful.PathParameter("id", "规则ID").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("name", "规则名称").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("enable", "规则是否启用，true为启用，false为不启用").
			DataType("boolean").Required(false)).
		Param(restful.PathParameter("namespace", "命名空间").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("level", "熔断级别，可输入多个，逗号分割：1服务，2接口，3分组，4实例").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("service", "规则所关联服务，必须和serviceNamespace一起用").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("serviceNamespace", "规则所关联服务的命名空间，必须和service一起用").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("srcService", "规则的源服务名，模糊匹配").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("srcNamespace", "规则的源命名空间，模糊匹配").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("dstService", "规则的目标服务名，模糊匹配").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("dstNamespace", "规则的目标命名空间，模糊匹配").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("dstMethod", "规则的目标方法名，模糊匹配").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("description", "规则描述，模糊匹配").
			DataType(typeNameString).Required(true)).
		Returns(0, "", struct {
			BatchQueryResponse
			Data []fault_tolerance.CircuitBreakerRule `json:"data"`
		}{})
}

func EnrichEnableCircuitBreakerRulesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("启用熔断规则").
		Metadata(restfulspec.KeyOpenAPITags, circuitBreakersApiTags).
		Reads([]fault_tolerance.CircuitBreakerRule{}, "enable circuitbreaker rule").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichCreateFaultDetectRulesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("创建主动探测规则").
		Metadata(restfulspec.KeyOpenAPITags, faultDetectsApiTags).
		Reads([]apifault.FaultDetectRule{}, "create fault detect rules").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichDeleteFaultDetectRulesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("删除主动探测规则").
		Metadata(restfulspec.KeyOpenAPITags, faultDetectsApiTags).
		Reads([]apifault.FaultDetectRule{}, "delete fault detect rules").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichUpdateFaultDetectRulesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("更新主动探测规则").
		Metadata(restfulspec.KeyOpenAPITags, faultDetectsApiTags).
		Reads([]apifault.FaultDetectRule{}, "update fault detect rules").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichGetFaultDetectRulesApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("查询主动探测规则").
		Metadata(restfulspec.KeyOpenAPITags, faultDetectsApiTags).
		Param(restful.PathParameter("brief", "是否只显示概要信息，brief=true时，"+
			"则不返回规则详情，只返回规则列表概要信息，默认为false").DataType(typeNameBool).
			Required(false).DefaultValue("false")).
		Param(restful.PathParameter("offset", "分页的起始位置，默认为0").DataType(typeNameInteger).
			Required(false).DefaultValue("0")).
		Param(restful.PathParameter("limit", "每页行数，默认100  ").DataType(typeNameInteger).
			Required(false).DefaultValue("100")).
		Param(restful.PathParameter("id", "规则ID").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("name", "规则名称").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("enable", "规则是否启用，true为启用，false为不启用").
			DataType("boolean").Required(false)).
		Param(restful.PathParameter("namespace", "命名空间").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("service", "规则所关联服务，必须和serviceNamespace一起用").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("serviceNamespace", "规则所关联服务的命名空间，必须和service一起用").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("dstService", "规则的目标服务名，模糊匹配").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("dstNamespace", "规则的目标命名空间，模糊匹配").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("dstMethod", "规则的目标方法名，模糊匹配").
			DataType(typeNameString).Required(true)).
		Param(restful.PathParameter("description", "规则描述，模糊匹配").
			DataType(typeNameString).Required(true)).
		Returns(0, "", struct {
			BatchQueryResponse
			Data []fault_tolerance.FaultDetectConfig `json:"data"`
		}{})
}

func EnrichCreateRouterRuleApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("创建路由规则(V2)").
		Metadata(restfulspec.KeyOpenAPITags, routingRulesApiTags).
		Operation("v2CreateRoutings").
		Reads([]RouteRule{}, `
		SourceMatch.Type: CUSTOM/METHOD/HEADER/QUERY/CALLER_IP/PATH/COOKIE
		SourceMatch.Value.Type: EXACT/REGEX/NOT_EQUALS/IN/NOT_IN/RANGE
		SourceMatch.Value.ValueType: TEXT/PARAMETER
		SourceMatch.Type: CUSTOM/METHOD/HEADER/QUERY/CALLER_IP/PATH/COOKIE
		SourceMatch.Value.Type: EXACT/REGEX/NOT_EQUALS/IN/NOT_IN/RANGE
		DestinationGroup.Labels.Value.Typee: EXACT/REGEX/NOT_EQUALS/IN/NOT_IN/RANGE
		DestinationGroup.Labels.Value.ValueType: TEXT/PARAMETER
		`).
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichDeleteRouterRuleApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("删除路由规则(V2)").
		Metadata(restfulspec.KeyOpenAPITags, routingRulesApiTags).
		Operation("v2DeleteRoutings").
		Reads([]RouteRule{}).
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichUpdateRouterRuleApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("更新路由规则(V2)").
		Metadata(restfulspec.KeyOpenAPITags, routingRulesApiTags).
		Operation("v2UpdateRoutings").
		Reads([]RouteRule{}).
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}

func EnrichGetRouterRuleApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("获取路由规则(V2)").
		Metadata(restfulspec.KeyOpenAPITags, routingRulesApiTags).
		Param(restful.PathParameter("id", "规则ID").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("name", "规则名称").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("service", "服务名称，匹配 source 或者 destination").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("namespace", "命名空间，匹配 source 或者 destination").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("source_service", "服务名称，只匹配 source").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("source_namespace", "命名空间，只匹配 source").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("destination_service", "服务名称，只匹配 destination").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("destination_namespace", "命名空间，只匹配 destination").DataType(typeNameString).
			Required(false)).
		Param(restful.PathParameter("enable", "查询符合对应启用状态").DataType(typeNameBool).
			Required(false)).
		Param(restful.PathParameter("offset", "分页的起始位置，默认为0").DataType(typeNameInteger).
			Required(false).
			DefaultValue("0")).
		Param(restful.PathParameter("limit", "每页行数，默认100").DataType(typeNameInteger).
			Required(false).
			DefaultValue("100")).
		Operation("v2GetRoutings").
		Returns(0, "", struct {
			BatchQueryResponse
			Data []RouteRule `json:"data"`
		}{})
}

func EnrichEnableRouterRuleApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
	return r.Doc("启用路由规则(V2)").
		Metadata(restfulspec.KeyOpenAPITags, routingRulesApiTags).
		Reads([]RouteRule{}).
		Operation("v2EnableRoutings").
		Returns(0, "", struct {
			BatchWriteResponse
			Responses []struct {
				BaseResponse
			} `json:"responses"`
		}{})
}