Skip to content

Commit 49a7b60

Browse files
authored
Merge pull request #121 from SocketDev/automated/open-api
Sync with OpenAPI definition
2 parents c1a8e87 + 9e055c1 commit 49a7b60

File tree

2 files changed

+197
-29
lines changed

2 files changed

+197
-29
lines changed

openapi.json

Lines changed: 143 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -331,33 +331,75 @@
331331
"type": "object",
332332
"additionalProperties": false,
333333
"properties": {
334-
"id": {
334+
"cveId": {
335335
"type": "string",
336336
"default": ""
337337
},
338-
"title": {
338+
"cwes": {
339+
"type": "array",
340+
"items": {
341+
"type": "object",
342+
"additionalProperties": false,
343+
"properties": {
344+
"description": {
345+
"type": "string",
346+
"default": ""
347+
},
348+
"id": {
349+
"type": "string",
350+
"default": ""
351+
},
352+
"name": {
353+
"type": "string",
354+
"default": ""
355+
}
356+
},
357+
"required": [
358+
"description",
359+
"id",
360+
"name"
361+
]
362+
}
363+
},
364+
"description": {
339365
"type": "string",
340366
"default": ""
341367
},
342-
"description": {
368+
"firstPatchedVersionIdentifier": {
369+
"type": "string",
370+
"default": ""
371+
},
372+
"ghsaId": {
343373
"type": "string",
344374
"default": ""
345375
},
346376
"severity": {
347377
"type": "string",
348-
"default": "low"
378+
"default": "critical"
379+
},
380+
"title": {
381+
"type": "string",
382+
"default": ""
349383
},
350384
"url": {
351385
"type": "string",
352386
"default": ""
387+
},
388+
"vulnerableVersionRange": {
389+
"type": "string",
390+
"default": ""
353391
}
354392
},
355393
"required": [
394+
"cveId",
395+
"cwes",
356396
"description",
357-
"id",
397+
"firstPatchedVersionIdentifier",
398+
"ghsaId",
358399
"severity",
359400
"title",
360-
"url"
401+
"url",
402+
"vulnerableVersionRange"
361403
]
362404
},
363405
"usage": {
@@ -400,33 +442,75 @@
400442
"type": "object",
401443
"additionalProperties": false,
402444
"properties": {
403-
"id": {
445+
"cveId": {
404446
"type": "string",
405447
"default": ""
406448
},
407-
"title": {
449+
"cwes": {
450+
"type": "array",
451+
"items": {
452+
"type": "object",
453+
"additionalProperties": false,
454+
"properties": {
455+
"description": {
456+
"type": "string",
457+
"default": ""
458+
},
459+
"id": {
460+
"type": "string",
461+
"default": ""
462+
},
463+
"name": {
464+
"type": "string",
465+
"default": ""
466+
}
467+
},
468+
"required": [
469+
"description",
470+
"id",
471+
"name"
472+
]
473+
}
474+
},
475+
"description": {
408476
"type": "string",
409477
"default": ""
410478
},
411-
"description": {
479+
"firstPatchedVersionIdentifier": {
480+
"type": "string",
481+
"default": ""
482+
},
483+
"ghsaId": {
412484
"type": "string",
413485
"default": ""
414486
},
415487
"severity": {
416488
"type": "string",
417489
"default": "high"
418490
},
491+
"title": {
492+
"type": "string",
493+
"default": ""
494+
},
419495
"url": {
420496
"type": "string",
421497
"default": ""
498+
},
499+
"vulnerableVersionRange": {
500+
"type": "string",
501+
"default": ""
422502
}
423503
},
424504
"required": [
505+
"cveId",
506+
"cwes",
425507
"description",
426-
"id",
508+
"firstPatchedVersionIdentifier",
509+
"ghsaId",
427510
"severity",
428511
"title",
429-
"url"
512+
"url",
513+
"vulnerableVersionRange"
430514
]
431515
},
432516
"usage": {
@@ -469,33 +553,75 @@
469553
"type": "object",
470554
"additionalProperties": false,
471555
"properties": {
472-
"id": {
556+
"cveId": {
473557
"type": "string",
474558
"default": ""
475559
},
476-
"title": {
560+
"cwes": {
561+
"type": "array",
562+
"items": {
563+
"type": "object",
564+
"additionalProperties": false,
565+
"properties": {
566+
"description": {
567+
"type": "string",
568+
"default": ""
569+
},
570+
"id": {
571+
"type": "string",
572+
"default": ""
573+
},
574+
"name": {
575+
"type": "string",
576+
"default": ""
577+
}
578+
},
579+
"required": [
580+
"description",
581+
"id",
582+
"name"
583+
]
584+
}
585+
},
586+
"description": {
477587
"type": "string",
478588
"default": ""
479589
},
480-
"description": {
590+
"firstPatchedVersionIdentifier": {
591+
"type": "string",
592+
"default": ""
593+
},
594+
"ghsaId": {
481595
"type": "string",
482596
"default": ""
483597
},
484598
"severity": {
485599
"type": "string",
486600
"default": "low"
487601
},
602+
"title": {
603+
"type": "string",
604+
"default": ""
605+
},
488606
"url": {
489607
"type": "string",
490608
"default": ""
609+
},
610+
"vulnerableVersionRange": {
611+
"type": "string",
612+
"default": ""
491613
}
492614
},
493615
"required": [
616+
"cveId",
617+
"cwes",
494618
"description",
495-
"id",
619+
"firstPatchedVersionIdentifier",
620+
"ghsaId",
496621
"severity",
497622
"title",
498-
"url"
623+
"url",
624+
"vulnerableVersionRange"
499625
]
500626
},
501627
"usage": {
@@ -5330,7 +5456,7 @@
53305456
"basicAuth": []
53315457
}
53325458
],
5333-
"description": "Get your current settings the requested organizations and default settings to allow deferals.\n\nThis endpoint consumes 0 units of your quota.",
5459+
"description": "Get your current settings the requested organizations and default settings to allow deferrals.\n\nThis endpoint consumes 0 units of your quota.",
53345460
"responses": {
53355461
"200": {
53365462
"content": {

types/api.d.ts

Lines changed: 54 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ export interface paths {
110110
"/settings": {
111111
/**
112112
* Calculate settings
113-
* @description Get your current settings the requested organizations and default settings to allow deferals.
113+
* @description Get your current settings the requested organizations and default settings to allow deferrals.
114114
*
115115
* This endpoint consumes 0 units of your quota.
116116
*/
@@ -193,15 +193,29 @@ export interface components {
193193
description: string;
194194
props: {
195195
/** @default */
196-
id: string;
197-
/** @default */
198-
title: string;
196+
cveId: string;
197+
cwes: ({
198+
/** @default */
199+
description: string;
200+
/** @default */
201+
id: string;
202+
/** @default */
203+
name: string;
204+
})[];
199205
/** @default */
200206
description: string;
201-
/** @default low */
207+
/** @default */
208+
firstPatchedVersionIdentifier: string;
209+
/** @default */
210+
ghsaId: string;
211+
/** @default critical */
202212
severity: string;
203213
/** @default */
214+
title: string;
215+
/** @default */
204216
url: string;
217+
/** @default */
218+
vulnerableVersionRange: string;
205219
};
206220
usage?: components["schemas"]["SocketUsageRef"];
207221
};
@@ -213,15 +227,29 @@ export interface components {
213227
description: string;
214228
props: {
215229
/** @default */
216-
id: string;
217-
/** @default */
218-
title: string;
230+
cveId: string;
231+
cwes: ({
232+
/** @default */
233+
description: string;
234+
/** @default */
235+
id: string;
236+
/** @default */
237+
name: string;
238+
})[];
219239
/** @default */
220240
description: string;
241+
/** @default */
242+
firstPatchedVersionIdentifier: string;
243+
/** @default */
244+
ghsaId: string;
221245
/** @default high */
222246
severity: string;
223247
/** @default */
248+
title: string;
249+
/** @default */
224250
url: string;
251+
/** @default */
252+
vulnerableVersionRange: string;
225253
};
226254
usage?: components["schemas"]["SocketUsageRef"];
227255
};
@@ -233,15 +261,29 @@ export interface components {
233261
description: string;
234262
props: {
235263
/** @default */
236-
id: string;
237-
/** @default */
238-
title: string;
264+
cveId: string;
265+
cwes: ({
266+
/** @default */
267+
description: string;
268+
/** @default */
269+
id: string;
270+
/** @default */
271+
name: string;
272+
})[];
239273
/** @default */
240274
description: string;
275+
/** @default */
276+
firstPatchedVersionIdentifier: string;
277+
/** @default */
278+
ghsaId: string;
241279
/** @default low */
242280
severity: string;
243281
/** @default */
282+
title: string;
283+
/** @default */
244284
url: string;
285+
/** @default */
286+
vulnerableVersionRange: string;
245287
};
246288
usage?: components["schemas"]["SocketUsageRef"];
247289
};
@@ -1664,7 +1706,7 @@ export interface operations {
16641706
};
16651707
/**
16661708
* Calculate settings
1667-
* @description Get your current settings the requested organizations and default settings to allow deferals.
1709+
* @description Get your current settings the requested organizations and default settings to allow deferrals.
16681710
*
16691711
* This endpoint consumes 0 units of your quota.
16701712
*/

0 commit comments

Comments
 (0)