-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdoc.go
111 lines (106 loc) · 3.59 KB
/
doc.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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
package health
// Alive returns an ok status if the instance is ready to handle HTTP requests.
//
// swagger:route GET /health/alive public isInstanceAlive
//
// Check Alive Status
//
// This endpoint returns a 200 status code when the HTTP server is up running.
// This status does currently not include checks whether the database connection is working.
//
// If the service supports TLS Edge Termination, this endpoint does not require the
// `X-Forwarded-Proto` header to be set.
//
// Be aware that if you are running multiple nodes of this service, the health status will never
// refer to the cluster state, only to a single instance.
//
// Produces:
// - application/json
//
// Responses:
// 200: healthStatus
// 500: genericError
func swaggerPublicIsInstanceAlive() {}
// Alive returns an ok status if the instance is ready to handle HTTP requests.
//
// swagger:route GET /health/alive admin isInstanceAlive
//
// Check Alive Status
//
// This endpoint returns a 200 status code when the HTTP server is up running.
// This status does currently not include checks whether the database connection is working.
//
// If the service supports TLS Edge Termination, this endpoint does not require the
// `X-Forwarded-Proto` header to be set.
//
// Be aware that if you are running multiple nodes of this service, the health status will never
// refer to the cluster state, only to a single instance.
//
// Produces:
// - application/json
//
// Responses:
// 200: healthStatus
// 500: genericError
func swaggerAdminIsInstanceAlive() {}
// Ready returns an ok status if the instance is ready to handle HTTP requests and all ReadyCheckers are ok.
//
// swagger:route GET /health/ready health isInstanceReady
//
// Check Readiness Status
//
// This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g.
// the database) are responsive as well.
//
// If the service supports TLS Edge Termination, this endpoint does not require the
// `X-Forwarded-Proto` header to be set.
//
// Be aware that if you are running multiple nodes of this service, the health status will never
// refer to the cluster state, only to a single instance.
//
// Produces:
// - application/json
//
// Responses:
// 200: healthStatus
// 503: healthNotReadyStatus
func swaggerAdminIsInstanceReady() {}
// Ready returns an ok status if the instance is ready to handle HTTP requests and all ReadyCheckers are ok.
//
// swagger:route GET /health/ready public isInstanceReady
//
// Check Readiness Status
//
// This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g.
// the database) are responsive as well.
//
// If the service supports TLS Edge Termination, this endpoint does not require the
// `X-Forwarded-Proto` header to be set.
//
// Be aware that if you are running multiple nodes of this service, the health status will never
// refer to the cluster state, only to a single instance.
//
// Produces:
// - application/json
//
// Responses:
// 200: healthStatus
// 503: healthNotReadyStatus
func swaggerPublicIsInstanceReady() {}
// Version returns this service's versions.
//
// swagger:route GET /version admin getVersion
//
// Get Service Version
//
// This endpoint returns the service version typically notated using semantic versioning.
//
// If the service supports TLS Edge Termination, this endpoint does not require the
// `X-Forwarded-Proto` header to be set.
//
// Produces:
// - application/json
//
// Responses:
// 200: version
func swaggerGetVersion() {}