-
Notifications
You must be signed in to change notification settings - Fork 75
/
Copy pathopenapi.yml
2023 lines (2023 loc) · 68.4 KB
/
openapi.yml
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.2
info:
title: CVE Services API
description: The CVE services API which supports automation tooling for the CVE Project.
termsOfService: https://placeholder.cve.mitre.org/api/terms
contact:
name: CVE Services API
url: https://github.com/CVEProject/cve-services
email: cve-board-auto-list@mitre.org
license:
name: Creative Commons Zero v1.0 Universal
url: https://creativecommons.org/publicdomain/zero/1.0/legalcode
version: 1.0.0
servers:
- url: https://cveawg.mitre.org/api
description: Production server
components:
parameters:
api-entity-header:
in: header
name: CVE-API-ORG
description: The shortname for the entity (e.g., CNA, ADP) that is authenticated or requesting authentication.
required: true
schema:
type: string
api-user-header:
in: header
name: CVE-API-USER
description: The username for the account that is making the request.
required: true
schema:
type: string
api-secret-header:
in: header
name: CVE-API-KEY
description: The user's API key.
required: true
schema:
type: string
cve-id-path:
in: path
name: cve-id
description: The CVE ID for which the record is being submitted.
required: true
schema:
type: string
pattern: '^CVE-[0-9]{4}-[0-9]{4,}$'
shortname-path:
in: path
name: shortname
description: The short name of the organization.
required: true
schema:
type: string
username-path:
in: path
name: username
description: The user name of the user.
required: true
schema:
type: string
page-query:
in: query
name: page
description: The current page in the paginator.
required: false
schema:
type: integer
format: int32
minimum: 1
schemas:
cve-id:
type: object
properties:
cve_id:
type: string
pattern: ^CVE-[0-9]{4}-[0-9]{4,}$
cve_year:
type: string
pattern: ^[0-9]{4}$
owning_cna:
type: string
description: The shortname for the organization that owns the CVE-ID.
state:
type: string
enum: [RESERVED, PUBLIC, REJECT]
requested_by:
type: object
properties:
cna:
type: string
description: The shortname for the organization of the user that requested the ID.
user:
type: string
description: The username for the account that requested the ID.
reserved:
type: string
format: date-time
description: The time the ID was reserved.
time:
type: object
properties:
created:
type: string
format: date-time
description: The time the ID was created.
modified:
type: string
format: date-time
description: The last time the ID was modified.
cve-id-no-time:
type: object
properties:
cve_id:
type: string
pattern: ^CVE-[0-9]{4}-[0-9]{4,}$
cve_year:
type: string
pattern: ^[0-9]{4}$
owning_cna:
type: string
description: The shortname for the organization that owns the CVE-ID.
state:
type: string
enum: [RESERVED, PUBLIC, REJECT]
requested_by:
type: object
properties:
cna:
type: string
description: The shortname for the organization of the user that requested the ID.
user:
type: string
description: The username for the account that requested the ID.
reserved:
type: string
format: date-time
description: The time the ID was reserved.
org:
type: object
properties:
name:
type: string
description: The name of the organization.
short_name:
type: string
description: The short name of the organization.
UUID:
type: string
description: The identifier of the organization.
policies:
type: object
properties:
id_quota:
type: integer
format: int32
description: The number of CVE IDs the organization is allowed to have in the RESERVED state at one time.
minimum: 0
maximum: 100000
authority:
type: object
properties:
active_roles:
type: array
items:
type: string
description: The active roles of the organization.
enum: ['CNA','SECRETARIAT','ROOT_CNA','ADP']
time:
type: object
properties:
created:
type: string
format: date-time
description: The time the organization was created.
modified:
type: string
format: date-time
description: The last time the organization was modified.
org-no-time:
type: object
properties:
name:
type: string
description: The name of the organization.
short_name:
type: string
description: The short name of the organization.
UUID:
type: string
description: The identifier of the organization.
policies:
type: object
properties:
id_quota:
type: integer
format: int32
description: The number of CVE IDs the organization is allowed to have in the RESERVED state at one time.
authority:
type: object
properties:
active_roles:
type: array
items:
type: string
description: The active roles of the organization.
enum: ['CNA','SECRETARIAT','ROOT_CNA','ADP']
user-no-time-secret:
type: object
properties:
username:
type: string
description: The user name of the user.
org_UUID:
type: string
description: The identifier of the organization the user belongs to.
UUID:
type: string
description: The identifier of the user.
active:
type: boolean
description: The user is an active user of the organization.
name:
type: object
properties:
first:
type: string
description: The first name of the user.
last:
type: string
description: The last name of the user.
middle:
type: string
description: The middle name of the user, if any.
surname:
type: string
description: The surname of the user, if any.
suffix:
type: string
description: The suffix of the user, if any.
authority:
type: object
properties:
active_roles:
type: array
items:
type: string
description: The active roles of the user.
enum: ['ADMIN']
user:
type: object
properties:
username:
type: string
description: The user name of the user.
org_UUID:
type: string
description: The identifier of the organization the user belongs to.
UUID:
type: string
description: The identifier of the user.
active:
type: boolean
description: The user is an active user of the organization.
name:
type: object
properties:
first:
type: string
description: The first name of the user.
last:
type: string
description: The last name of the user.
middle:
type: string
description: The middle name of the user, if any.
surname:
type: string
description: The surname of the user, if any.
suffix:
type: string
description: The suffix of the user, if any.
secret:
type: string
description: The API key of the user.
authority:
type: object
properties:
active_roles:
type: array
items:
type: string
description: The active roles of the user.
enum: ['ADMIN']
time:
type: object
properties:
created:
type: string
format: date-time
description: The time the user was created.
modified:
type: string
format: date-time
description: The last time the user was modified.
user-no-secret:
type: object
properties:
username:
type: string
description: The user name of the user.
org_UUID:
type: string
description: The identifier of the organization the user belongs to.
UUID:
type: string
description: The identifier of the user.
active:
type: boolean
description: The user is an active user of the organization.
name:
type: object
properties:
first:
type: string
description: The first name of the user.
last:
type: string
description: The last name of the user.
middle:
type: string
description: The middle name of the user, if any.
surname:
type: string
description: The surname of the user, if any.
suffix:
type: string
description: The suffix of the user, if any.
authority:
type: object
properties:
active_roles:
type: array
items:
type: string
description: The active roles of the user.
enum: ['ADMIN']
time:
type: object
properties:
created:
type: string
format: date-time
description: The time the user was created.
modified:
type: string
format: date-time
description: The last time the user was modified.
arrayOfCveIds:
type: array
items:
$ref: '#/components/schemas/cve-id'
arrayOfCveIdsNoTime:
type: array
items:
$ref: '#/components/schemas/cve-id-no-time'
arrayOfCveRecords:
type: array
items:
anyOf:
- $ref: 'https://raw.githubusercontent.com/CVEProject/cve-schema/master/schema/v4.0/CVE_JSON_4.0_min_public.schema'
- $ref: 'https://raw.githubusercontent.com/CVEProject/cve-schema/master/schema/v4.0/CVE_JSON_4.0_min_reject.schema'
arrayOfOrgs:
type: array
items:
$ref: '#/components/schemas/org'
arrayOfOrgsNoTime:
type: array
items:
$ref: '#/components/schemas/org-no-time'
arrayOfUsersNoSecret:
type: array
items:
$ref: '#/components/schemas/user-no-secret'
errorCveIds:
type: object
properties:
error:
type: string
description: Error name
message:
type: string
description: Error description
details:
type: object
properties:
amount_reserved:
type: integer
format: int32
description: The amount of IDs that were reserved in the system.
cve_ids:
type: array
items:
$ref: '#/components/schemas/cve-id-no-time'
errorValidator:
type: object
properties:
error:
type: string
description: Error name
message:
type: string
description: Error description
details:
type: object
properties:
errors:
type: array
items:
type: string
description: The errors encountered by the JSON validator.
errorIdQuota:
type: object
properties:
error:
type: string
description: Error name
message:
type: string
description: Error description
details:
type: object
properties:
id_quota:
type: integer
format: int32
description: The number of CVE IDs the organization is allowed to have in the RESERVED state at one time.
total_reserved:
type: integer
format: int32
description: The total number of CVE IDs across all years that the organization has in the RESERVED state.
available:
type: integer
format: int32
description: The number of CVE IDs that can be reserved by the organization (e.g., id_quota - total_reserved).
errorBadInput:
type: object
properties:
error:
type: string
description: Error name
message:
type: string
description: Error description
details:
type: array
items:
type: object
properties:
msg:
type: string
description: Invalid value
param:
type: string
description: The name of the parameter with the error
location:
type: string
enum: ['body', 'param', 'query']
description: The location of the parameter
errorGeneric:
type: object
properties:
error:
type: string
description: Error name
message:
type: string
description: Error description
paths:
/cve-id-range/{year}:
parameters:
- $ref: '#/components/parameters/api-entity-header'
- $ref: '#/components/parameters/api-secret-header'
- $ref: '#/components/parameters/api-user-header'
- in: path
name: year
description: The year of the CVE-ID-Range record.
required: true
schema:
type: integer
format: int32
post:
summary: Creates a CVE-ID-Range record for the specified year
description: |
<h2>Access Control</h2>
<p>At least one of the following roles are needed to access the endpoint:</p>
<p>- <b>SECRETARIAT:</b> The user must belong to an Organization with the “SECRETARIAT” role</p>
<h2>Expected Behavior</h2>
<p><b>Secretariat:</b> Can create a CVE-ID-Range record for the specified year</p>
operationId: cveIdRangeCreate
x-org-roles:
type: String
enum: ['SECRETARIAT']
description: The user must belong to an Organization with the “SECRETARIAT” role to access the endpoint
x-user-roles:
type: String
enum: ['']
description: No user roles needed to access the endpoint
responses:
200:
description: The CVE-ID-Range entity was created.
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorBadInput'
401:
description: Not Authenticated
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
/cve-id:
parameters:
- $ref: '#/components/parameters/api-entity-header'
- $ref: '#/components/parameters/api-secret-header'
- $ref: '#/components/parameters/api-user-header'
get:
summary: Retrieves all CVE IDs entity owns after applying the query params
description: |
<h2>Access Control</h2>
<p>No roles needed to access the endpoint</p>
<h2>Expected Behavior</h2>
<p><b>Secretariat:</b> Can see CVE-IDs owned by any Organization</p>
<p><b>Admin User:</b> Can only see CVE-IDs owned by the Organization it belongs to</p>
<p><b>Regular User:</b> Can only see CVE-IDs owned by the Organization it belongs to</p>
operationId: cveIdGetFiltered
x-org-roles:
type: String
enum: ['']
description: No Organization roles needed to access the endpoint
x-user-roles:
type: String
enum: ['']
description: No user roles needed to access the endpoint
parameters:
- in: query
name: state
description: Filter by CVE state [RESERVED, PUBLIC, or REJECT].
required: false
schema:
type: string
- in: query
name: cve_id_year
description: Filter by the year in the CVE ID (YYYY).
required: false
schema:
type: integer
format: int32
- in: query
name: time_reserved.lt
description: Get all CVE-ID records reserved before timestamp.
required: false
schema:
type: string
format: date-time
- in: query
name: time_reserved.gt
description: Get all CVE-ID records reserved after timestamp.
required: false
schema:
type: string
format: date-time
- in: query
name: time_modified.lt
description: Get all CVE-ID records modified before timestamp.
required: false
schema:
type: string
format: date-time
- in: query
name: time_modified.gt
description: Get all CVE-ID records modified after timestamp.
required: false
schema:
type: string
format: date-time
- $ref: '#/components/parameters/page-query'
responses:
200:
description: A filtered list of CVE-ID records the organization owns given the query parameters.
content:
application/json:
schema:
type: object
properties:
totalCount:
type: integer
format: int32
description: Total CVE records found
itemsPerPage:
type: integer
format: int32
description: Number of CVE records in a page
pageCount:
type: integer
format: int32
description: Total number of pages
currentPage:
type: integer
format: int32
description: Current page
prevPage:
type: integer
format: int32
description: Previous page
nextPage:
type: integer
format: int32
description: Next page
cve_ids:
$ref: '#/components/schemas/arrayOfCveIds'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorBadInput'
401:
description: Not Authenticated
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
post:
summary: Reserves CVE-ID records for the organization provided in the short_name query parameter
description: |
<h2>Access Control</h2>
<p>At least one of the following roles are needed to access the endpoint:</p>
<p>- <b>CNA:</b> The user must belong to an Organization with the “CNA” role</p>
<h2>Expected Behavior</h2>
<p><b>Secretariat:</b> Can reserve CVE-IDs for any Organization</p>
<p><b>CNA:</b> Can only reserve CVE-IDs for its Organization</p>
operationId: cveIdReserve
x-org-roles:
type: String
enum: ['CNA']
description: The user must belong to an Organization with the “CNA” role to access the endpoint
x-user-roles:
type: String
enum: ['']
description: No user roles needed to access the endpoint
parameters:
- in: query
name: batch_type
description: When the amount is greater than one, it indicates whether the CVE IDs should be sequential or non-sequential.
required: false
schema:
type: string
enum: [sequential, nonsequential, non-sequential]
- in: query
name: amount
description: Amount of CVE IDs to reserve.
required: true
schema:
type: integer
format: int32
- in: query
name: cve_year
description: The year the CVE IDs will be reserved for. (i.e., 1999, ..., currentYear + 1)
required: true
schema:
type: integer
format: int32
- in: query
name: short_name
description: The CNA that will own the CVE IDs reserved.
required: true
schema:
type: string
responses:
200:
description: A list of the newly reserved CVE-IDs.
content:
application/json:
schema:
type: object
properties:
cve_ids:
$ref: '#/components/schemas/arrayOfCveIdsNoTime'
206:
description: A partial list of the CVE-IDs the IDR service managed to reserve before encountering a case where no more CVE IDs could be reserved.
content:
application/json:
schema:
$ref: '#/components/schemas/errorCveIds'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorBadInput'
401:
description: Not Authenticated
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
/cve-id/{cve-id}:
parameters:
- $ref: '#/components/parameters/api-entity-header'
- $ref: '#/components/parameters/api-secret-header'
- $ref: '#/components/parameters/api-user-header'
- $ref: '#/components/parameters/cve-id-path'
get:
summary: Retrieves a CVE-ID record by ID, can be a cve id the entity doesn't own if in a PUBLIC or REJECT state
description: |
<h2>Access Control</h2>
<p>No roles needed to access the endpoint</p>
<h2>Expected Behavior</h2>
<p><b>Secretariat:</b> Can see the full information of a CVE-ID owned by any Organization</p>
<p><b>Admin User:</b> Can see full information of a CVE-ID owned by the Organization it belongs to, and can only see partial information of a CVE-ID in the “PUBLIC” or “REJECT” state that is owned by another Organization</p>
<p><b>Regular User:</b> Can see full information of a CVE-ID owned by the Organization it belongs to, and can only see partial information of a CVE-ID in the “PUBLIC” or “REJECT” state that is owned by another Organization</p>
operationId: cveIdGetSingle
x-org-roles:
type: String
enum: ['']
description: No Organization roles needed to access the endpoint
x-user-roles:
type: String
enum: ['']
description: No user roles needed to access the endpoint
responses:
200:
description: The requested CVE-ID record is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/cve-id'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorBadInput'
401:
description: Not Authenticated
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
put:
summary: Updates a CVE-ID record by ID
description: |
<h2>Access Control</h2>
<p>At least one of the following roles are needed to access the endpoint:</p>
<p>- <b>SECRETARIAT:</b> The user must belong to an Organization with the “SECRETARIAT” role</p>
<h2>Expected Behavior</h2>
<p><b>Secretariat:</b> Can update a CVE-ID owned by any Organization</p>
operationId: cveIdUpdateSingle
x-org-roles:
type: String
enum: ['SECRETARIAT']
description: The user must belong to an Organization with the “SECRETARIAT” role to access the endpoint
x-user-roles:
type: String
enum: ['']
description: No user roles needed to access the endpoint
parameters:
- in: query
name: state
description: Update the state of a CVE-ID record.
required: false
schema:
type: string
- in: query
name: org
description: Update the owning_cna of a CVE-ID record.
required: false
schema:
type: string
responses:
200:
description: The updated CVE-ID record is returned.
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Success description
updated:
$ref: '#/components/schemas/cve-id'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorBadInput'
401:
description: Not Authenticated
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
/cve:
parameters:
- $ref: '#/components/parameters/api-entity-header'
- $ref: '#/components/parameters/api-secret-header'
- $ref: '#/components/parameters/api-user-header'
get:
summary: Retrieves all CVE records
description: |
<h2>Access Control</h2>
<p>At least one of the following roles are needed to access the endpoint:</p>
<p>- <b>SECRETARIAT:</b> The user must belong to an Organization with the “SECRETARIAT” role</p>
<h2>Expected Behavior</h2>
<p><b>Secretariat:</b> Can see all CVE records owned by any Organization</p>
operationId: cveGetFiltered
x-org-roles:
type: String
enum: ['SECRETARIAT']
description: The user must belong to an Organization with the “SECRETARIAT” role to access the endpoint
x-user-roles:
type: String
enum: ['']
description: No user roles needed to access the endpoint
parameters:
- in: query
name: time_modified.lt
description: Get all CVE records modified before timestamp.
required: false
schema:
type: string
format: date-time
- in: query
name: time_modified.gt
description: Get all CVE records modified after timestamp.
required: false
schema:
type: string
format: date-time
- $ref: '#/components/parameters/page-query'
responses:
200:
description: A list of CVE records and pagination fields, only allowed by the Secretariat.
content:
application/json:
schema:
type: object
properties:
totalCount:
type: integer
format: int32
description: Total CVE records found
itemsPerPage:
type: integer
format: int32
description: Number of CVE records in a page
pageCount:
type: integer
format: int32
description: Total number of pages
currentPage:
type: integer
format: int32
description: Current page
prevPage:
type: integer
format: int32
description: Previous page
nextPage:
type: integer
format: int32
description: Next page
cveRecords:
$ref: '#/components/schemas/arrayOfCveRecords'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorBadInput'
401:
description: Not Authenticated
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
500:
description: Internal Server
content:
application/json:
schema:
$ref: '#/components/schemas/errorGeneric'
/cve/{cve-id}: