-
Notifications
You must be signed in to change notification settings - Fork 0
/
OpenAPI.yaml.min-example
130 lines (128 loc) · 3.22 KB
/
OpenAPI.yaml.min-example
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
openapi: 3.1.0
info:
title: My-Service
description: My service just do exist, so it mainly implements the mmost important API endpoints livez and readyz required by Kubernetes
version: 0.0.1
servers:
- url: http://localhost:{port}
description: The main component container of the pod
variables:
port:
default: "8080"
paths:
/:
get:
summary: Returns the index content of my service
tags:
- builtin
operationId: Root
responses:
"200":
description: This entrypoint delivers the index page.
content:
text/html:
schema:
type: string
/livez:
get:
summary: deliver the state of the service
tags:
- builtin
responses:
"200":
description: service is alive
content:
text/plain:
schema:
type: string
/readyz:
get:
summary: deliver the state of the service
tags:
- builtin
responses:
"200":
description: service is ready to service requests
content:
text/plain:
schema:
type: string
"503":
description: service is not ready to service requests, e.g. waiting to finish its initialisation or waiting for other services to become ready
content:
text/plain:
schema:
type: string
/infoz:
get:
summary: relevant meta information about the service
tags:
- builtin
responses:
"200":
description: deliver all properties like service name and version
content:
application/json:
schema:
type: string
/events:
get:
summary: SSE events service
tags:
- builtin
responses:
"200":
description: SSE event communication
content:
text/plain:
schema:
type: string
post:
summary: SSE events service
tags:
- builtin
responses:
"200":
description: SSE event communication
content:
text/plain:
schema:
type: string
/robots.txt:
get:
summary: return robots.txt to restrict web crawlers
tags:
- builtin
responses:
"200":
description: deliver robots.txt
content:
application/json:
schema:
type: string
/index.html:
get:
summary: index.html is the main page, which embeds content.html with the main content
tags:
- builtin
responses:
"200":
description: successfully deliver index.html
content:
text/html:
schema:
type: string
/content.html:
get:
summary: content.html contains the main content, which can be flexible embeded as a component in the overall index page
tags:
- builtin
responses:
"200":
description: successfully deliver content.html
content:
text/html:
schema:
type: string
components:
schemas: