-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathopen-api-schema.json
More file actions
184 lines (183 loc) · 10.5 KB
/
open-api-schema.json
File metadata and controls
184 lines (183 loc) · 10.5 KB
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
{
"openapi": "3.0.0",
"info": {
"title": "Kubernetes Pods Automation API",
"version": "1.0.0",
"description": "API for listing Kubernetes resources by Namespace."
},
"paths": {
"/namespaces": {
"get": {
"summary": "Get a list of all namespaces in a Kubernetes cluster",
"description": "Get a list of all namespaces in a Kubernetes cluster. This API return all the namespace names.",
"operationId": "getAllNamespaces",
"responses": {
"200": {
"description": "Gets the list of all namespaces in a Kubernetes cluster",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"namespace_name": {
"type": "string",
"description": "name of the namespace"
}
}
}
}
}
}
}
}
}
},
"/namespaces/{namespace_name}/get-pods": {
"get": {
"summary": "Get a list of pods in a specified namespace.",
"description": "Get a list of pods in a specified namespace. The API takes in only one namespace name and returns the list of pods in the associated namespace.",
"operationId": "getPods",
"parameters": [{
"name": "namespace_name",
"in": "path",
"description": "Unique name of the namespace",
"required": true,
"schema": {
"type": "string"
}
}],
"responses": {
"200": {
"description": "List of pods in a specified namespace",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pods": {
"type": "array",
"description": "An array of pods in the specified namespace.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the pod"
},
"phase": {
"type": "string",
"description": "The phase of the pod"
},
"containers": {
"type": "array",
"description": "An array of containers belonging to the pod",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the container"
},
"image": {
"type": "string",
"description": "Image of the container"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"/reports/cis": {
"get": {
"summary": "Get the CIS Benchmark compliance report",
"description": "Get the CIS Benchmark compliance report. This API returns an object with the compliance control checks specification and the status results.",
"operationId": "getCISReport",
"responses": {
"200": {
"description": "CIS Benchmark compliance report object",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "object",
"description": "The status object",
"properties": {
"summary": {
"type": "object",
"description": "The summary object",
"properties": {
"failCount": {
"type": "integer",
"description": "Number of failed checks"
},
"passCount": {
"type": "integer",
"description": "Number of passed checks"
}
}
},
"summaryReport": {
"type": "object",
"description": "The summary report object",
"properties": {
"controlCheck": {
"type": "array",
"description": "An array of control checks",
"items": {
"type": "object",
"description": "A control check object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the control check"
},
"name": {
"type": "string",
"description": "Name of the control check"
},
"severity": {
"type": "string",
"description": "Severity of the control check"
},
"totalFail": {
"type": "integer",
"description": "Total number of failed checks"
}
}
}
},
"id": {
"type": "string",
"description": "Unique ID of the summary report"
},
"title": {
"type": "string",
"description": "Title of the summary report"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}