/
naming_client_access_apidoc.go
69 lines (61 loc) · 2.48 KB
/
naming_client_access_apidoc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/**
* 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/service_manage"
apiservice "github.com/polarismesh/specification/source/go/api/v1/service_manage"
)
var (
registerInstanceApiTags = []string{"Client"}
)
func EnrichReportClientApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
return r.Doc("上报客户端信息").
Metadata(restfulspec.KeyOpenAPITags, registerInstanceApiTags).
Doc("上报客户端").
Reads(apiservice.Client{}).
Returns(0, "", struct {
BaseResponse
Client service_manage.Client `json:"client,omitempty"`
}{})
}
func EnrichRegisterInstanceApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
return r.Doc("注册实例").
Metadata(restfulspec.KeyOpenAPITags, registerInstanceApiTags).
Reads(apiservice.Instance{}).
Returns(0, "", service_manage.Instance{})
}
func EnrichDeregisterInstanceApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
return r.Doc("注销实例").
Metadata(restfulspec.KeyOpenAPITags, registerInstanceApiTags).
Reads(apiservice.Instance{}).
Returns(0, "", service_manage.Instance{})
}
func EnrichHeartbeatApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
return r.Doc("上报心跳").
Metadata(restfulspec.KeyOpenAPITags, registerInstanceApiTags).
Reads(apiservice.Instance{}).
Returns(0, "", service_manage.Instance{})
}
func EnrichDiscoverApiDocs(r *restful.RouteBuilder) *restful.RouteBuilder {
return r.Doc("服务发现").
Metadata(restfulspec.KeyOpenAPITags, registerInstanceApiTags).
Reads(DiscoverRequest{},
"Type 支持 [UNKNOWN/INSTANCE/ROUTING/RATE_LIMIT/CIRCUIT_BREAKER/SERVICES/NAMESPACES/FAULT_DETECTOR]").
Returns(0, "", service_manage.DiscoverResponse{})
}