-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
containeranalysis.v1beta1.json
6074 lines (6074 loc) 路 205 KB
/
containeranalysis.v1beta1.json
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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://containeranalysis.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Container Analysis",
"description": "This API is a prerequisite for leveraging Artifact Analysis scanning capabilities in both Artifact Registry and with Advanced Vulnerability Insights (runtime scanning) in GKE. In addition, the Container Analysis API is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "containeranalysis:v1beta1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://containeranalysis.mtls.googleapis.com/",
"name": "containeranalysis",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"notes": {
"methods": {
"batchCreate": {
"description": "Creates new notes in batch.",
"flatPath": "v1beta1/projects/{projectsId}/notes:batchCreate",
"httpMethod": "POST",
"id": "containeranalysis.projects.notes.batchCreate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/notes:batchCreate",
"request": {
"$ref": "BatchCreateNotesRequest"
},
"response": {
"$ref": "BatchCreateNotesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a new note.",
"flatPath": "v1beta1/projects/{projectsId}/notes",
"httpMethod": "POST",
"id": "containeranalysis.projects.notes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"noteId": {
"description": "Required. The ID to use for this note.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/notes",
"request": {
"$ref": "Note"
},
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified note.",
"flatPath": "v1beta1/projects/{projectsId}/notes/{notesId}",
"httpMethod": "DELETE",
"id": "containeranalysis.projects.notes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the specified note.",
"flatPath": "v1beta1/projects/{projectsId}/notes/{notesId}",
"httpMethod": "GET",
"id": "containeranalysis.projects.notes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.",
"flatPath": "v1beta1/projects/{projectsId}/notes/{notesId}:getIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.projects.notes.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists notes for the specified project.",
"flatPath": "v1beta1/projects/{projectsId}/notes",
"httpMethod": "GET",
"id": "containeranalysis.projects.notes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Token to provide to skip to a particular spot in the list.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/notes",
"response": {
"$ref": "ListNotesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified note.",
"flatPath": "v1beta1/projects/{projectsId}/notes/{notesId}",
"httpMethod": "PATCH",
"id": "containeranalysis.projects.notes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Note"
},
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.",
"flatPath": "v1beta1/projects/{projectsId}/notes/{notesId}:setIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.projects.notes.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.",
"flatPath": "v1beta1/projects/{projectsId}/notes/{notesId}:testIamPermissions",
"httpMethod": "POST",
"id": "containeranalysis.projects.notes.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"occurrences": {
"methods": {
"list": {
"description": "Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.",
"flatPath": "v1beta1/projects/{projectsId}/notes/{notesId}/occurrences",
"httpMethod": "GET",
"id": "containeranalysis.projects.notes.occurrences.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Number of occurrences to return in the list.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Token to provide to skip to a particular spot in the list.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}/occurrences",
"response": {
"$ref": "ListNoteOccurrencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"occurrences": {
"methods": {
"batchCreate": {
"description": "Creates new occurrences in batch.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences:batchCreate",
"httpMethod": "POST",
"id": "containeranalysis.projects.occurrences.batchCreate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/occurrences:batchCreate",
"request": {
"$ref": "BatchCreateOccurrencesRequest"
},
"response": {
"$ref": "BatchCreateOccurrencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a new occurrence.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences",
"httpMethod": "POST",
"id": "containeranalysis.projects.occurrences.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/occurrences",
"request": {
"$ref": "Occurrence"
},
"response": {
"$ref": "Occurrence"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences/{occurrencesId}",
"httpMethod": "DELETE",
"id": "containeranalysis.projects.occurrences.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the specified occurrence.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences/{occurrencesId}",
"httpMethod": "GET",
"id": "containeranalysis.projects.occurrences.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Occurrence"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.projects.occurrences.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getNotes": {
"description": "Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences/{occurrencesId}/notes",
"httpMethod": "GET",
"id": "containeranalysis.projects.occurrences.getNotes",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}/notes",
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getVulnerabilitySummary": {
"description": "Gets a summary of the number and severity of occurrences.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences:vulnerabilitySummary",
"httpMethod": "GET",
"id": "containeranalysis.projects.occurrences.getVulnerabilitySummary",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/occurrences:vulnerabilitySummary",
"response": {
"$ref": "VulnerabilityOccurrencesSummary"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists occurrences for the specified project.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences",
"httpMethod": "GET",
"id": "containeranalysis.projects.occurrences.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Token to provide to skip to a particular spot in the list.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/occurrences",
"response": {
"$ref": "ListOccurrencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified occurrence.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences/{occurrencesId}",
"httpMethod": "PATCH",
"id": "containeranalysis.projects.occurrences.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Occurrence"
},
"response": {
"$ref": "Occurrence"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.projects.occurrences.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.",
"flatPath": "v1beta1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions",
"httpMethod": "POST",
"id": "containeranalysis.projects.occurrences.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"resources": {
"methods": {
"exportSBOM": {
"description": "Generates an SBOM and other dependency information for the given resource.",
"flatPath": "v1beta1/projects/{projectsId}/resources/{resourcesId}:exportSBOM",
"httpMethod": "POST",
"id": "containeranalysis.projects.resources.exportSBOM",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.",
"location": "path",
"pattern": "^projects/[^/]+/resources/.*$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:exportSBOM",
"request": {
"$ref": "ExportSBOMRequest"
},
"response": {
"$ref": "ExportSBOMResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"generatePackagesSummary": {
"description": "Gets a summary of the packages within a given resource.",
"flatPath": "v1beta1/projects/{projectsId}/resources/{resourcesId}:generatePackagesSummary",
"httpMethod": "POST",
"id": "containeranalysis.projects.resources.generatePackagesSummary",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource to get a packages summary for in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.",
"location": "path",
"pattern": "^projects/[^/]+/resources/.*$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:generatePackagesSummary",
"request": {
"$ref": "GeneratePackagesSummaryRequest"
},
"response": {
"$ref": "PackagesSummaryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20240220",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"AliasContext": {
"description": "An alias to a repo revision.",
"id": "AliasContext",
"properties": {
"kind": {
"description": "The alias kind.",
"enum": [
"KIND_UNSPECIFIED",
"FIXED",
"MOVABLE",
"OTHER"
],
"enumDescriptions": [
"Unknown.",
"Git tag.",
"Git branch.",
"Used to specify non-standard aliases. For example, if a Git repo has a ref named \"refs/foo/bar\"."
],
"type": "string"
},
"name": {
"description": "The alias name.",
"type": "string"
}
},
"type": "object"
},
"AnalysisCompleted": {
"description": "Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.",
"id": "AnalysisCompleted",
"properties": {
"analysisType": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Artifact": {
"description": "Artifact describes a build product.",
"id": "Artifact",
"properties": {
"checksum": {
"description": "Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.",
"type": "string"
},
"id": {
"description": "Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.",
"type": "string"
},
"names": {
"description": "Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ArtifactHashes": {
"description": "Defines a hash object for use in Materials and Products.",
"id": "ArtifactHashes",
"properties": {
"sha256": {
"type": "string"
}
},
"type": "object"
},
"ArtifactRule": {
"description": "Defines an object to declare an in-toto artifact rule",
"id": "ArtifactRule",
"properties": {
"artifactRule": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Assessment": {
"description": "Assessment provides all information that is related to a single vulnerability for this product.",
"id": "Assessment",
"properties": {
"cve": {
"deprecated": true,
"description": "Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.",
"type": "string"
},
"impacts": {
"description": "Contains information about the impact of this vulnerability, this will change with time.",
"items": {
"type": "string"
},
"type": "array"
},
"justification": {
"$ref": "Justification",
"description": "Justification provides the justification when the state of the assessment if NOT_AFFECTED."
},
"longDescription": {
"description": "A detailed description of this Vex.",
"type": "string"
},
"relatedUris": {
"description": "Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.",
"items": {
"$ref": "RelatedUrl"
},
"type": "array"
},
"remediations": {
"description": "Specifies details on how to handle (and presumably, fix) a vulnerability.",
"items": {
"$ref": "Remediation"
},
"type": "array"
},
"shortDescription": {
"description": "A one sentence description of this Vex.",
"type": "string"
},
"state": {
"description": "Provides the state of this Vulnerability assessment.",
"enum": [
"STATE_UNSPECIFIED",
"AFFECTED",
"NOT_AFFECTED",
"FIXED",
"UNDER_INVESTIGATION"
],
"enumDescriptions": [
"No state is specified.",
"This product is known to be affected by this vulnerability.",
"This product is known to be not affected by this vulnerability.",
"This product contains a fix for this vulnerability.",
"It is not known yet whether these versions are or are not affected by the vulnerability. However, it is still under investigation."
],
"type": "string"
},
"vulnerabilityId": {
"description": "The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.",
"type": "string"
}
},
"type": "object"
},
"Attestation": {
"description": "Occurrence that represents a single \"attestation\". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for).",
"id": "Attestation",
"properties": {
"genericSignedAttestation": {
"$ref": "GenericSignedAttestation"
},
"pgpSignedAttestation": {
"$ref": "PgpSignedAttestation",
"description": "A PGP signed attestation."
}
},
"type": "object"
},
"Authority": {
"description": "Note kind that represents a logical attestation \"role\" or \"authority\". For example, an organization might have one `Authority` for \"QA\" and one for \"build\". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project.",
"id": "Authority",
"properties": {
"hint": {
"$ref": "Hint",
"description": "Hint hints at the purpose of the attestation authority."
}
},
"type": "object"
},
"Basis": {
"description": "Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url.",
"id": "Basis",