blob: 69a6de8dfd8c9755d453f91e2147656c7106b9ce (
plain)
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
openapi: 3.0.1
info:
title: OpenAPI definition for SDC Helm validator
description: Application for validating Helm charts.
version: v0
servers:
- url: http://localhost:8080
description: Generated server url
tags:
- name: Actuator
description: Monitor and interact
externalDocs:
description: Spring Boot Actuator Web API Documentation
url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
paths:
/validate:
post:
tags:
- ValidationService
summary: Validate chart
description: Web endpoint for Helm charts validation. Helm chart in .tgz format
is required.
operationId: validate
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/ValidationRequestParameters'
required: true
responses:
"500":
description: Something went wrong during validation execution
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
"200":
description: Helm chart successfully validated
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResult'
examples:
Simple Validation:
$ref: '#/components/examples/simpleValidation'
Lint Validation:
$ref: '#/components/examples/validationWithLint'
"400":
description: Chart cannot be validated using selected version
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
/versions:
get:
tags:
- VersionsService
summary: Show Helm versions
description: Web endpoint for showing supported Helm versions.
operationId: supportedVersions
responses:
"500":
description: Something went wrong during getting Helm versions
content:
'*/*':
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
"200":
description: Supported Helm versions successfully returned
content:
'*/*':
schema:
$ref: '#/components/schemas/VersionsResponse'
/actuator:
get:
tags:
- Actuator
summary: Actuator root web endpoint
operationId: links_0
responses:
"200":
description: OK
content:
'*/*':
schema:
type: object
additionalProperties:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
/actuator/info:
get:
tags:
- Actuator
summary: Actuator web endpoint 'info'
operationId: handle_1
responses:
"200":
description: OK
content:
'*/*':
schema:
type: object
/actuator/health:
get:
tags:
- Actuator
summary: Actuator web endpoint 'health'
operationId: handle_2
responses:
"200":
description: OK
content:
'*/*':
schema:
type: object
/actuator/health/**:
get:
tags:
- Actuator
summary: Actuator web endpoint 'health-path'
operationId: handle_3
responses:
"200":
description: OK
content:
'*/*':
schema:
type: object
components:
schemas:
VersionsResponse:
properties:
versions:
type: array
items:
type: string
ValidationRequestParameters:
required:
- file
type: object
properties:
versionDesired:
type: string
description: "Desired Helm version which should be used to validate the\
\ chart. If parameter is not provided validation is processing with version\
\ based on chart's apiVersion. Version could be provided in 'semantic\
\ version' or 'major version'.<br> Allowed formats: <br>- Semantic version\
\ [X.Y.Z] e.g. 3.5.2 <br>- Major version [vX] e.g. v3"
file:
type: string
format: binary
isLinted:
type: boolean
description: "If true, there will be an attempt to lint chart"
isStrictLinted:
type: boolean
description: Strict linting marks the chart as invalid if detect any warning
ValidationErrorResponse:
type: object
properties:
message:
type: string
ValidationResult:
type: object
properties:
renderErrors:
type: array
items:
type: string
lintWarning:
type: array
items:
type: string
lintError:
type: array
items:
type: string
versionUsed:
type: string
valid:
type: boolean
deployable:
type: boolean
Link:
type: object
properties:
href:
type: string
templated:
type: boolean
examples:
simpleValidation:
description: Example response when parameter isLinted is set to false
value: "{\"renderErrors\":[],\"versionUsed\":\"3.5.2\",\"deployable\":true}"
validationWithLint:
description: Example response when parameter isLinted is set to true
value: "{\"renderErrors\":[],\"lintWarning\":[],\"lintError\":[],\"versionUsed\"\
:\"3.5.2\",\"valid\":true,\"deployable\":true}"
|
