forked from Tufin/oasdiff
-
Notifications
You must be signed in to change notification settings - Fork 0
/
changelog.html
244 lines (176 loc) · 8.37 KB
/
changelog.html
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<html>
<head>
<style>
@import url(//fonts.googleapis.com/css?family=Nunito);
* {
font-family: 'Nunito','Helvetica Neue',Helvetica,Arial,sans-serif;
}
.title {
margin: 1em 0 0.5em 0;
font-size: 36px;
}
.path {
color: #016BF8;
font-size: 18px;
font-weight: 600;
}
.endpoint {
color: #21313c;
line-height: 24px;
margin: 22px 0;
}
.endpoint-header {
display: inline-flex;
align-items: center;
gap: 5px;
}
.change-type {
box-sizing: border-box;
font-weight: 700;
font-size: 12px;
line-height: 16px;
border-radius: 5px;
height: 18px;
padding-left: 6px;
padding-right: 6px;
text-transform: uppercase;
border: 1px solid;
letter-spacing: 1px;
background-color: #E3FCF7;
border-color: #C0FAE6;
color: #00684A;
margin-top: 2px;
}
.change {
}
.breaking {
display: inline-flex;
align-items: center;
gap: 5px;
margin-right: 5px;
}
.breaking-icon {
color: #DB3030;
}
.endpoint-changes {
}
.tooltip {
position:relative;
}
.tooltip:before {
content: attr(data-text);
position:absolute;
top:50%;
transform:translateY(-50%);
left:100%;
margin-left:15px;
width:200px;
padding:10px;
border-radius:10px;
background:#000;
color: #fff;
text-align:center;
display:none;
}
.tooltip:hover:before {
display:block;
}
</style>
</head>
<body>
<div class="title">API Changelog 1.0.0 vs. 1.0.1 </div>
<div class="endpoint">
<div class="endpoint-header">
<span class="path">
<div class="">GET /api/{domain}/{project}/badges/security-score</div>
</span>
<div class="change-type">Updated</div>
</div>
<ul class="endpoint-changes">
<li class="change">
<div class="breaking tooltip" data-text="Breaking Change">
<svg xmlns="http:https://www.w3.org/2000/svg" width="16" height="16" fill="none" viewBox="0 0 16 16" class="breaking-icon" role="img" aria-label="Important With Circle Icon"><path fill="currentColor" fill-rule="evenodd" d="M8 15A7 7 0 1 0 8 1a7 7 0 0 0 0 14ZM7 4.5a1 1 0 0 1 2 0v4a1 1 0 0 1-2 0v-4Zm2 7a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" clip-rule="evenodd"></path></svg>
</div>
removed the success response with the status '200'
</li>
<li class="change">
<div class="breaking tooltip" data-text="Breaking Change">
<svg xmlns="http:https://www.w3.org/2000/svg" width="16" height="16" fill="none" viewBox="0 0 16 16" class="breaking-icon" role="img" aria-label="Important With Circle Icon"><path fill="currentColor" fill-rule="evenodd" d="M8 15A7 7 0 1 0 8 1a7 7 0 0 0 0 14ZM7 4.5a1 1 0 0 1 2 0v4a1 1 0 0 1-2 0v-4Zm2 7a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" clip-rule="evenodd"></path></svg>
</div>
removed the success response with the status '201'
</li>
<li class="change">
<div class="breaking tooltip" data-text="Breaking Change">
<svg xmlns="http:https://www.w3.org/2000/svg" width="16" height="16" fill="none" viewBox="0 0 16 16" class="breaking-icon" role="img" aria-label="Important With Circle Icon"><path fill="currentColor" fill-rule="evenodd" d="M8 15A7 7 0 1 0 8 1a7 7 0 0 0 0 14ZM7 4.5a1 1 0 0 1 2 0v4a1 1 0 0 1-2 0v-4Zm2 7a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" clip-rule="evenodd"></path></svg>
</div>
deleted the 'cookie' request parameter 'test'
</li>
<li class="change">
<div class="breaking tooltip" data-text="Breaking Change">
<svg xmlns="http:https://www.w3.org/2000/svg" width="16" height="16" fill="none" viewBox="0 0 16 16" class="breaking-icon" role="img" aria-label="Important With Circle Icon"><path fill="currentColor" fill-rule="evenodd" d="M8 15A7 7 0 1 0 8 1a7 7 0 0 0 0 14ZM7 4.5a1 1 0 0 1 2 0v4a1 1 0 0 1-2 0v-4Zm2 7a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" clip-rule="evenodd"></path></svg>
</div>
deleted the 'header' request parameter 'user'
</li>
<li class="change">
<div class="breaking tooltip" data-text="Breaking Change">
<svg xmlns="http:https://www.w3.org/2000/svg" width="16" height="16" fill="none" viewBox="0 0 16 16" class="breaking-icon" role="img" aria-label="Important With Circle Icon"><path fill="currentColor" fill-rule="evenodd" d="M8 15A7 7 0 1 0 8 1a7 7 0 0 0 0 14ZM7 4.5a1 1 0 0 1 2 0v4a1 1 0 0 1-2 0v-4Zm2 7a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" clip-rule="evenodd"></path></svg>
</div>
deleted the 'query' request parameter 'filter'
</li>
<li class="change">
api operation id 'GetSecurityScores' removed and replaced with 'GetSecurityScore'
</li>
<li class="change">
api tag 'security' removed
</li>
<li class="change">
for the 'query' request parameter 'token', the maxLength was increased from '29' to '30'
</li>
<li class="change">
removed the pattern '^(?:[\w-./:]+)$' from the 'query' request parameter 'image'
</li>
<li class="change">
removed the non-success response with the status '400'
</li>
</ul>
</div>
<div class="endpoint">
<div class="endpoint-header">
<span class="path">
<div class="">GET /api/{domain}/{project}/install-command</div>
</span>
<div class="change-type">Updated</div>
</div>
<ul class="endpoint-changes">
<li class="change">
<div class="breaking tooltip" data-text="Breaking Change">
<svg xmlns="http:https://www.w3.org/2000/svg" width="16" height="16" fill="none" viewBox="0 0 16 16" class="breaking-icon" role="img" aria-label="Important With Circle Icon"><path fill="currentColor" fill-rule="evenodd" d="M8 15A7 7 0 1 0 8 1a7 7 0 0 0 0 14ZM7 4.5a1 1 0 0 1 2 0v4a1 1 0 0 1-2 0v-4Zm2 7a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" clip-rule="evenodd"></path></svg>
</div>
deleted the 'header' request parameter 'network-policies'
</li>
<li class="change">
added the new optional 'header' request parameter 'name' to all path's operations
</li>
<li class="change">
added the new enum value 'test1' to the 'path' request parameter 'project'
</li>
</ul>
</div>
<div class="endpoint">
<div class="endpoint-header">
<span class="path">
<div class="">POST /register</div>
</span>
<div class="change-type">Updated</div>
</div>
<ul class="endpoint-changes">
<li class="change">
the endpoint scheme security 'bearerAuth' was removed from the API
</li>
<li class="change">
the security scope 'write:pets' was added to the endpoint's security scheme 'OAuth'
</li>
</ul>
</div>
</body>
</html>